MinioClient (api 3.0.7 API)

java.lang.Object
- io.minio.MinioClient

```
public final class MinioClient
extends Object
```
This class implements a simple cloud storage client. This client consists of a useful subset of S3 compatible functionality.

Service
- Creating a bucket
- Listing buckets
Bucket
- Creating an object, including automatic upload resuming for large objects.
- Listing objects in a bucket
- Listing active multipart uploads
Object
- Removing an active multipart upload for a specific object and uploadId
- Read object metadata
- Reading an object
- Reading a range of bytes of an object
- Deleting an object
Optionally, users can also provide access/secret keys. If keys are provided, all requests by the client will be signed using AWS Signature Version 4.
For examples on using this library, please see .

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 using secure (HTTPS) connection.
`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 option.
`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 option.
`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 option.
`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 (HTTPS) 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`	`copyObject(String bucketName, String objectName, String destBucketName)` Copy a source object into a new destination object with same object name.
`void`	`copyObject(String bucketName, String objectName, String destBucketName, CopyConditions copyConditions)` Copy a source object into a new object with the provided name in the provided bucket.
`void`	`copyObject(String bucketName, String objectName, String destBucketName, String destObjectName)` Copy a source object into a new destination object.
`void`	`copyObject(String bucketName, String objectName, String destBucketName, String destObjectName, CopyConditions copyConditions)` Copy a source object into a new object with the provided name in the provided bucket.
`void`	`copyObject(String bucketName, String objectName, String destBucketName, String destObjectName, CopyConditions copyConditions, Map<String,String> metadata)` Copy a source object into a new object with the provided name in the provided bucket.
`NotificationConfiguration`	`getBucketNotification(String bucketName)` Get bucket notification configuration
`PolicyType`	`getBucketPolicy(String bucketName, String objectPrefix)` Get bucket policy at given objectPrefix
`InputStream`	`getObject(String bucketName, String objectName)` Gets entire object's data as `InputStream` in given bucket.
`InputStream`	`getObject(String bucketName, String objectName, KeyPair key)` Returns `InputStream` containing decrypted data of given object.
`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, SecretKey key)` Returns `InputStream` containing decrypted data of given object.
`void`	`getObject(String bucketName, String objectName, String fileName)` Gets object's data in the given bucket and stores it to given file name.
`String`	`getObjectUrl(String bucketName, String objectName)` Gets object's URL in given bucket.
`void`	`ignoreCertCheck()` Ignores check on server certificate for HTTPS connection.
`List<Bucket>`	`listBuckets()` Returns all bucket information owned by the current user.
`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.
`void`	`makeBucket(String bucketName)` Creates a bucket with default region.
`void`	`makeBucket(String bucketName, String region)` Creates a bucket with given region.
`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, long size, Map<String,String> headerMap)` Uploads data from given stream as object to given bucket with specified meta data.
`void`	`putObject(String bucketName, String objectName, InputStream stream, long size, String contentType)` Uploads data from given stream as object to given bucket.
`void`	`putObject(String bucketName, String objectName, InputStream stream, long size, String contentType, KeyPair keypair)` Uploads encrypted data from given stream as object to given bucket where data is encrypted on the fly using passed keypair.
`void`	`putObject(String bucketName, String objectName, InputStream stream, long size, String contentType, SecretKey key)` Uploads encrypted data from given stream as object to given bucket where data is encrypted on the fly using passed secret key.
`void`	`putObject(String bucketName, String objectName, InputStream stream, String contentType)` Uploads data from given stream as object to given bucket where the stream size is unknown.
`void`	`putObject(String bucketName, String objectName, String fileName)` Uploads given file as object in given bucket.
`void`	`putObject(String bucketName, String objectName, String fileName, String contentType)` Uploads given file as object in given bucket.
`void`	`removeAllBucketNotification(String bucketName)` Remove all bucket notification.
`void`	`removeBucket(String bucketName)` Removes a bucket.
`void`	`removeIncompleteUpload(String bucketName, String objectName)` Removes incomplete multipart upload of given object.
`Iterable<Result<DeleteError>>`	`removeObject(String bucketName, Iterable<String> objectNames)` Removes multiple objects from a bucket.
`void`	`removeObject(String bucketName, String objectName)` Removes an object from a bucket.
`void`	`setAppInfo(String name, String version)` Sets application's name/version to user agent.
`void`	`setBucketNotification(String bucketName, NotificationConfiguration notificationConfiguration)` Set bucket notification configuration
`void`	`setBucketPolicy(String bucketName, String objectPrefix, PolicyType policyType)` Set policy on bucket and object prefix.
`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.
`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.minio.io:9000"); 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.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.minio.io:9000")); 
```
  Parameters:
  
  url - Endpoint 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.minio.io:9000")); 
```
  Parameters:
  
  url - Endpoint 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.minio.io:9000",
                            "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY"); 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  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.minio.io:9000",
                            "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", "us-east-1"); 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  region - Region name to access service in endpoint.
  
  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.minio.io:9000"),
                            "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY"); 
```
  Parameters:
  
  url - Endpoint URL object.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  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.minio.io:9000"),
                            "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY"); 
```
  Parameters:
  
  url - Endpoint HttpUrl object.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  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 using secure (HTTPS) connection.
  Example:
```
 MinioClient minioClient =
                  new MinioClient("play.minio.io", 9000, "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY");
 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  port - Valid port. It should be in between 1 and 65535. Unused if endpoint is an URL.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  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 (HTTPS) connection.
  Example:
```
 MinioClient minioClient =
                      new MinioClient("play.minio.io:9000", "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", true);
 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  secure - If true, access endpoint using HTTPS else access it using HTTP.
  
  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 option.
  Example:
```
 MinioClient minioClient =
          new MinioClient("play.minio.io", 9000, "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", false);
 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  port - Valid port. It should be in between 1 and 65535. Unused if endpoint is an URL.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  secure - If true, access endpoint using HTTPS else access it using HTTP.
  
  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 option.
  Example:
```
 MinioClient minioClient =
          new MinioClient("play.minio.io", 9000, "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", "us-east-1", false);
 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  port - Valid port. It should be in between 1 and 65535. Unused if endpoint is an URL.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  region - Region name to access service in endpoint.
  
  secure - If true, access endpoint using HTTPS else access it using HTTP.
  
  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 option.
  Example:
```
 MinioClient minioClient =
          new MinioClient("play.minio.io", 9000, "YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY", "us-east-1", false,
          customHttpClient);
 
```
  Parameters:
  endpoint - Request endpoint. Endpoint is an URL, domain name, IPv4 or IPv6 address.
```
              Valid endpoints:
              * https://s3.amazonaws.com
              * https://s3.amazonaws.com/
              * https://play.minio.io:9000
              * http://play.minio.io:9010/
              * localhost
              * localhost.localdomain
              * play.minio.io
              * 127.0.0.1
              * 192.168.1.60
              * ::1
```
  port - Valid port. It should be in between 1 and 65535. Unused if endpoint is an URL.
  
  accessKey - Access key to access service in endpoint.
  
  secretKey - Secret key to access service in endpoint.
  
  region - Region name to access service in endpoint.
  
  secure - If true, access endpoint using HTTPS else access it using HTTP.
  
  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

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.

statObject

public ObjectStat statObject(String bucketName,
                             String objectName)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException

Returns meta data information of given object in given bucket.

Example:

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

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: Populated object metadata.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException
See Also:: ObjectStat

getObjectUrl

public String getObjectUrl(String bucketName,
                           String objectName)
                    throws InvalidBucketNameException,
                           NoSuchAlgorithmException,
                           InsufficientDataException,
                           IOException,
                           InvalidKeyException,
                           NoResponseException,
                           org.xmlpull.v1.XmlPullParserException,
                           ErrorResponseException,
                           InternalException

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");
 System.out.println(url);

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

getObject

public InputStream getObject(String bucketName,
                             String objectName)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException,
                             InvalidArgumentException

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");
 byte[] buf = new byte[16384];
 int bytesRead;
 while ((bytesRead = stream.read(buf, 0, buf.length)) >= 0) {
   System.out.println(new String(buf, 0, bytesRead));
 }
 stream.close();

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: InputStream containing the object data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException

getObject

public InputStream getObject(String bucketName,
                             String objectName,
                             long offset)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException,
                             InvalidArgumentException

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);
 byte[] buf = new byte[16384];
 int bytesRead;
 while ((bytesRead = stream.read(buf, 0, buf.length)) >= 0) {
   System.out.println(new String(buf, 0, bytesRead));
 }
 stream.close();

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException

getObject

public InputStream getObject(String bucketName,
                             String objectName,
                             long offset,
                             Long length)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException,
                             InvalidArgumentException

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);
 byte[] buf = new byte[16384];
 int bytesRead;
 while ((bytesRead = stream.read(buf, 0, buf.length)) >= 0) {
   System.out.println(new String(buf, 0, bytesRead));
 }
 stream.close();

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException

getObject

public void getObject(String bucketName,
                      String objectName,
                      String fileName)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException

getObject

public InputStream getObject(String bucketName,
                             String objectName,
                             SecretKey key)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException,
                             InvalidArgumentException,
                             NoSuchPaddingException,
                             IllegalBlockSizeException,
                             BadPaddingException,
                             InvalidAlgorithmParameterException,
                             InvalidEncryptionMetadataException

Returns InputStream containing decrypted data of given object. Secret key passed to this method should be the same as the one used for putObject() operation.

The returned InputStream must be closed after use else the connection will remain open.

Example:

 {

   // Get object with symmetric master key used in putObject
   InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", key);
   byte[] buf = new byte[16384];
   int bytesRead;
   while ((bytesRead = stream.read(buf, 0, buf.length)) >= 0) {
     System.out.println(new String(buf, 0, bytesRead));
   }
   stream.close();
 }

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; key - Symmetric key used for corresponding putOject operation.
Returns:: InputStream containing the object data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidEncryptionMetadataException - upon encryption key/iv error; BadPaddingException - upon wrong padding; IllegalBlockSizeException - upon incorrect block size; NoSuchPaddingException - upon incorrect padding; InvalidAlgorithmParameterException - upon incorrect algorithm; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: getObject(String bucketName, String objectName), getObject(String bucketName, String objectName, long offset), getObject(String bucketName, String objectName, long offset, Long length), getObject(String bucketName, String objectName, String filename), getObject(String bucketName, String objectName, KeyPair key)

getObject

public InputStream getObject(String bucketName,
                             String objectName,
                             KeyPair key)
                      throws InvalidBucketNameException,
                             NoSuchAlgorithmException,
                             InsufficientDataException,
                             IOException,
                             InvalidKeyException,
                             NoResponseException,
                             org.xmlpull.v1.XmlPullParserException,
                             ErrorResponseException,
                             InternalException,
                             InvalidArgumentException,
                             NoSuchPaddingException,
                             IllegalBlockSizeException,
                             BadPaddingException,
                             InvalidAlgorithmParameterException,
                             InvalidEncryptionMetadataException

Returns InputStream containing decrypted data of given object. Keypair passed to this method should be the same as the one used for putObject() operation.

The returned InputStream must be closed after use else the connection will remain open.

Example:

 {
   // Get object with symmetric master key used in putObject
   InputStream stream = minioClient.getObject("my-bucketname", "my-objectname", keypair);
   byte[] buf = new byte[16384];
   int bytesRead;
   while ((bytesRead = stream.read(buf, 0, buf.length)) >= 0) {
     System.out.println(new String(buf, 0, bytesRead));
   }
   stream.close();
 }

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.; key - Asymmetric keypair used for corresponding putOject operation.
Returns:: InputStream containing the object data.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidEncryptionMetadataException - upon encryption key/iv error; BadPaddingException - upon wrong padding; IllegalBlockSizeException - upon incorrect block size; NoSuchPaddingException - upon incorrect padding; InvalidAlgorithmParameterException - upon incorrect algorithm; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: getObject(String bucketName, String objectName), getObject(String bucketName, String objectName, long offset), getObject(String bucketName, String objectName, long offset, Long length), getObject(String bucketName, String objectName, String filename), getObject(String bucketName, String objectName, SecretKey key)

copyObject

public void copyObject(String bucketName,
                       String objectName,
                       String destBucketName)
                throws InvalidKeyException,
                       InvalidBucketNameException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       NoResponseException,
                       ErrorResponseException,
                       InternalException,
                       IOException,
                       org.xmlpull.v1.XmlPullParserException,
                       InvalidArgumentException

Copy a source object into a new destination object with same object name.

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", "my-destbucketname");

Parameters:: bucketName - Bucket name where the object to be copied exists.; objectName - Object name source to be copied.; destBucketName - Bucket name where the object will be copied to.
Throws:: InvalidBucketNameException - upon an invalid bucket name; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidKeyException - upon an invalid access key or secret key; InsufficientDataException; NoResponseException; ErrorResponseException; InternalException; IOException; org.xmlpull.v1.XmlPullParserException; InvalidArgumentException

copyObject

public void copyObject(String bucketName,
                       String objectName,
                       String destBucketName,
                       String destObjectName)
                throws InvalidKeyException,
                       InvalidBucketNameException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       NoResponseException,
                       ErrorResponseException,
                       InternalException,
                       IOException,
                       org.xmlpull.v1.XmlPullParserException,
                       InvalidArgumentException

Copy a source object into a new destination object.

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", "my-destbucketname", "my-destobjname");

Parameters:: bucketName - Bucket name where the object to be copied exists.; objectName - Object name source to be copied.; destBucketName - Bucket name where the object will be copied to.; destObjectName - Object name to be created, if not provided uses source object name as destination object name.
Throws:: InvalidBucketNameException - upon an invalid bucket name; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidKeyException - upon an invalid access key or secret key; InsufficientDataException; NoResponseException; ErrorResponseException; InternalException; IOException; org.xmlpull.v1.XmlPullParserException; InvalidArgumentException

copyObject

public void copyObject(String bucketName,
                       String objectName,
                       String destBucketName,
                       CopyConditions copyConditions)
                throws InvalidKeyException,
                       InvalidBucketNameException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       NoResponseException,
                       ErrorResponseException,
                       InternalException,
                       IOException,
                       org.xmlpull.v1.XmlPullParserException,
                       InvalidArgumentException

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

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", "my-destbucketname",
 copyConditions);

Parameters:: bucketName - Bucket name where the object to be copied exists.; objectName - Object name source to be copied.; destBucketName - Bucket name where the object will be copied to.; copyConditions - CopyConditions object with collection of supported CopyObject conditions.
Throws:: InvalidBucketNameException - upon an invalid bucket name; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidKeyException - upon an invalid access key or secret key; InsufficientDataException; NoResponseException; ErrorResponseException; InternalException; IOException; org.xmlpull.v1.XmlPullParserException; InvalidArgumentException

copyObject

public void copyObject(String bucketName,
                       String objectName,
                       String destBucketName,
                       String destObjectName,
                       CopyConditions copyConditions)
                throws InvalidKeyException,
                       InvalidBucketNameException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       NoResponseException,
                       ErrorResponseException,
                       InternalException,
                       IOException,
                       org.xmlpull.v1.XmlPullParserException,
                       InvalidArgumentException

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

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", "my-destbucketname",
 "my-destobjname", copyConditions);

Parameters:: bucketName - Bucket name where the object to be copied exists.; objectName - Object name source to be copied.; destBucketName - Bucket name where the object will be copied to.; destObjectName - Object name to be created, if not provided uses source object name as destination object name.; copyConditions - CopyConditions object with collection of supported CopyObject conditions.
Throws:: InvalidBucketNameException - upon an invalid bucket name, invalid object name.; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidKeyException - upon an invalid access key or secret key; InsufficientDataException; NoResponseException; ErrorResponseException; InternalException; IOException; org.xmlpull.v1.XmlPullParserException; InvalidArgumentException

copyObject

public void copyObject(String bucketName,
                       String objectName,
                       String destBucketName,
                       String destObjectName,
                       CopyConditions copyConditions,
                       Map<String,String> metadata)
                throws InvalidKeyException,
                       InvalidBucketNameException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       NoResponseException,
                       ErrorResponseException,
                       InternalException,
                       IOException,
                       org.xmlpull.v1.XmlPullParserException,
                       InvalidArgumentException

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

Example:

  minioClient.copyObject("my-bucketname", "my-objectname", "my-destbucketname",
 "my-destobjname", copyConditions, metadata);

Parameters:: bucketName - Bucket name where the object to be copied exists.; objectName - Object name source to be copied.; destBucketName - Bucket name where the object will be copied to.; destObjectName - Object name to be created, if not provided uses source object name as destination object name.; copyConditions - CopyConditions object with collection of supported CopyObject conditions.; metadata - Additional metadata to set on the destination object when setMetadataDirective is set to 'REPLACE'.
Throws:: InvalidBucketNameException - upon an invalid bucket name, invalid object name.; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidKeyException - upon an invalid access key or secret key; InsufficientDataException; NoResponseException; ErrorResponseException; InternalException; IOException; org.xmlpull.v1.XmlPullParserException; InvalidArgumentException

presignedGetObject

public String presignedGetObject(String bucketName,
                                 String objectName,
                                 Integer expires,
                                 Map<String,String> reqParams)
                          throws InvalidBucketNameException,
                                 NoSuchAlgorithmException,
                                 InsufficientDataException,
                                 IOException,
                                 InvalidKeyException,
                                 NoResponseException,
                                 org.xmlpull.v1.XmlPullParserException,
                                 ErrorResponseException,
                                 InternalException,
                                 InvalidExpiresRangeException

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);
 System.out.println(url);

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 an invalid bucket name; InvalidKeyException - upon an invalid access key or secret key; IOException - upon signature calculation failure; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidExpiresRangeException - upon input expires is out of range; InsufficientDataException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException

presignedGetObject

public String presignedGetObject(String bucketName,
                                 String objectName,
                                 Integer expires)
                          throws InvalidBucketNameException,
                                 NoSuchAlgorithmException,
                                 InsufficientDataException,
                                 IOException,
                                 InvalidKeyException,
                                 NoResponseException,
                                 org.xmlpull.v1.XmlPullParserException,
                                 ErrorResponseException,
                                 InternalException,
                                 InvalidExpiresRangeException

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);
 System.out.println(url);

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 an invalid bucket name; InvalidKeyException - upon an invalid access key or secret key; IOException - upon signature calculation failure; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidExpiresRangeException - upon input expires is out of range; InsufficientDataException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException

presignedGetObject

public String presignedGetObject(String bucketName,
                                 String objectName)
                          throws InvalidBucketNameException,
                                 NoSuchAlgorithmException,
                                 InsufficientDataException,
                                 IOException,
                                 InvalidKeyException,
                                 NoResponseException,
                                 org.xmlpull.v1.XmlPullParserException,
                                 ErrorResponseException,
                                 InternalException,
                                 InvalidExpiresRangeException

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");
 System.out.println(url);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: string contains URL to download the object
Throws:: IOException - upon connection error; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidExpiresRangeException - upon input expires is out of range; InvalidBucketNameException; InsufficientDataException; InvalidKeyException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException

presignedPutObject

public String presignedPutObject(String bucketName,
                                 String objectName,
                                 Integer expires)
                          throws InvalidBucketNameException,
                                 NoSuchAlgorithmException,
                                 InsufficientDataException,
                                 IOException,
                                 InvalidKeyException,
                                 NoResponseException,
                                 org.xmlpull.v1.XmlPullParserException,
                                 ErrorResponseException,
                                 InternalException,
                                 InvalidExpiresRangeException

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);
 System.out.println(url);

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 an invalid bucket name; InvalidKeyException - upon an invalid access key or secret key; IOException - upon signature calculation failure; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidExpiresRangeException - upon input expires is out of range; InsufficientDataException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException

presignedPutObject

public String presignedPutObject(String bucketName,
                                 String objectName)
                          throws InvalidBucketNameException,
                                 NoSuchAlgorithmException,
                                 InsufficientDataException,
                                 IOException,
                                 InvalidKeyException,
                                 NoResponseException,
                                 org.xmlpull.v1.XmlPullParserException,
                                 ErrorResponseException,
                                 InternalException,
                                 InvalidExpiresRangeException

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");
 System.out.println(url);

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Returns:: string contains URL to upload the object.
Throws:: IOException - upon connection error; NoSuchAlgorithmException - upon requested algorithm was not found during signature calculation; InvalidExpiresRangeException - upon input expires is out of range; InvalidBucketNameException; InsufficientDataException; InvalidKeyException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException

presignedPostPolicy

public Map<String,String> presignedPostPolicy(PostPolicy policy)
                                       throws InvalidBucketNameException,
                                              NoSuchAlgorithmException,
                                              InsufficientDataException,
                                              IOException,
                                              InvalidKeyException,
                                              NoResponseException,
                                              org.xmlpull.v1.XmlPullParserException,
                                              ErrorResponseException,
                                              InternalException,
                                              InvalidArgumentException

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

Example:

 // Create new PostPolicy object for 'my-bucketname', 'my-objectname' and 7 days expire time from now.
 PostPolicy policy = new PostPolicy("my-bucketname", "my-objectname", DateTime.now().plusDays(7));
 // 'my-objectname' should be 'image/png' content type
 policy.setContentType("image/png");
 Map<String,String> formData = minioClient.presignedPostPolicy(policy);
 // Print a curl command that can be executable with the file /tmp/userpic.png and the file will be uploaded.
 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.minio.io:9000/my-bucketname");

Parameters:: policy - Post policy of an object.
Returns:: Map of strings to construct form-data.
Throws:: InvalidBucketNameException; NoSuchAlgorithmException; InsufficientDataException; IOException; InvalidKeyException; NoResponseException; org.xmlpull.v1.XmlPullParserException; ErrorResponseException; InternalException; InvalidArgumentException
See Also:: PostPolicy

removeObject

public void removeObject(String bucketName,
                         String objectName)
                  throws InvalidBucketNameException,
                         NoSuchAlgorithmException,
                         InsufficientDataException,
                         IOException,
                         InvalidKeyException,
                         NoResponseException,
                         org.xmlpull.v1.XmlPullParserException,
                         ErrorResponseException,
                         InternalException

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

removeObject

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

Removes multiple objects from a bucket.

Example:

 // Create object list for removal.
 List<String> objectNames = new LinkedList<String>();
 objectNames.add("my-objectname1");
 objectNames.add("my-objectname2");
 objectNames.add("my-objectname3");
 for (Result<DeleteError> errorResult: minioClient.removeObject("my-bucketname", objectNames)) {
     DeleteError error = errorResult.get();
     System.out.println("Failed to remove '" + error.objectName() + "'. Error:" + error.message());
 }

Parameters:: bucketName - Bucket name.; objectNames - List of Object names in the bucket.

listObjects
```
public Iterable<Result<Item>> listObjects(String bucketName)
                                   throws org.xmlpull.v1.XmlPullParserException
```
Lists object information in given bucket.

Parameters:

bucketName - Bucket name.

Returns:

an iterator of Result Items.

Throws:

org.xmlpull.v1.XmlPullParserException

listObjects

public Iterable<Result<Item>> listObjects(String bucketName,
                                          String prefix)
                                   throws org.xmlpull.v1.XmlPullParserException

Lists object information in given bucket and prefix.

Parameters:: bucketName - Bucket name.; prefix - Prefix string. List objects whose name starts with `prefix`.
Returns:: an iterator of Result Items.
Throws:: org.xmlpull.v1.XmlPullParserException

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>> myObjects = minioClient.listObjects("my-bucketname");
 for (Result<Item> result : myObjects) {
   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>> myObjects = minioClient.listObjects("my-bucketname", "my-object-prefix", true,
                                    false);
 for (Result<Item> result : myObjects) {
   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)

listBuckets

public List<Bucket> listBuckets()
                         throws InvalidBucketNameException,
                                NoSuchAlgorithmException,
                                InsufficientDataException,
                                IOException,
                                InvalidKeyException,
                                NoResponseException,
                                org.xmlpull.v1.XmlPullParserException,
                                ErrorResponseException,
                                InternalException

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:: NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidBucketNameException; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

bucketExists

public boolean bucketExists(String bucketName)
                     throws InvalidBucketNameException,
                            NoSuchAlgorithmException,
                            InsufficientDataException,
                            IOException,
                            InvalidKeyException,
                            NoResponseException,
                            org.xmlpull.v1.XmlPullParserException,
                            ErrorResponseException,
                            InternalException

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; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

makeBucket

public void makeBucket(String bucketName)
                throws InvalidBucketNameException,
                       RegionConflictException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       IOException,
                       InvalidKeyException,
                       NoResponseException,
                       org.xmlpull.v1.XmlPullParserException,
                       ErrorResponseException,
                       InternalException

Creates a bucket with default region.

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; RegionConflictException; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

makeBucket

public void makeBucket(String bucketName,
                       String region)
                throws InvalidBucketNameException,
                       RegionConflictException,
                       NoSuchAlgorithmException,
                       InsufficientDataException,
                       IOException,
                       InvalidKeyException,
                       NoResponseException,
                       org.xmlpull.v1.XmlPullParserException,
                       ErrorResponseException,
                       InternalException

Creates a bucket with given region.

Example:

 minioClient.makeBucket("my-bucketname");
 System.out.println("my-bucketname is created successfully");

Parameters:: bucketName - Bucket name.; region - region in which the bucket will be created.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; RegionConflictException; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

removeBucket

public void removeBucket(String bucketName)
                  throws InvalidBucketNameException,
                         NoSuchAlgorithmException,
                         InsufficientDataException,
                         IOException,
                         InvalidKeyException,
                         NoResponseException,
                         org.xmlpull.v1.XmlPullParserException,
                         ErrorResponseException,
                         InternalException

Removes a bucket.

NOTE: - All objects (including all object versions and delete markers) in the bucket must be deleted prior, this API will not recursively delete objects

Example:

 minioClient.removeBucket("my-bucketname");
 System.out.println("my-bucketname is removed successfully");

Parameters:: bucketName - Bucket name.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

putObject
```
public void putObject(String bucketName,
                      String objectName,
                      String fileName,
                      String contentType)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      InsufficientDataException
```
Uploads given file as object in given bucket.
If the object is larger than 5MB, the client will automatically use a multipart session.

If the session fails, the user may attempt to re-upload the object by attempting to create the exact same object again. The client will examine all parts of any current upload session and attempt to reuse the session automatically. If a mismatch is discovered, the upload will fail before uploading any more data. Otherwise, it will resume uploading where the session left off.

If the multipart session fails, the user is responsible for resuming or removing the session.

Parameters:

bucketName - Bucket name.

objectName - Object name to create in the bucket.

fileName - File name to upload.

contentType - File content type of the object, user supplied.

Throws:

InvalidBucketNameException - upon invalid bucket name is given

NoResponseException - upon no response from server

IOException - upon connection error

org.xmlpull.v1.XmlPullParserException - upon parsing response xml

ErrorResponseException - upon unsuccessful execution

InternalException - upon internal library error

NoSuchAlgorithmException

InsufficientDataException

InvalidKeyException

InvalidArgumentException

putObject
```
public void putObject(String bucketName,
                      String objectName,
                      String fileName)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      InsufficientDataException
```
Uploads given file as object in given bucket.
If the object is larger than 5MB, the client will automatically use a multipart session.

If the session fails, the user may attempt to re-upload the object by attempting to create the exact same object again. The client will examine all parts of any current upload session and attempt to reuse the session automatically. If a mismatch is discovered, the upload will fail before uploading any more data. Otherwise, it will resume uploading where the session left off.

If the multipart session fails, the user is responsible for resuming or removing the session.

Parameters:

bucketName - Bucket name.

objectName - Object name to create in the bucket.

fileName - File name to upload.

Throws:

InvalidBucketNameException - upon invalid bucket name is given

NoResponseException - upon no response from server

IOException - upon connection error

org.xmlpull.v1.XmlPullParserException - upon parsing response xml

ErrorResponseException - upon unsuccessful execution

InternalException - upon internal library error

NoSuchAlgorithmException

InsufficientDataException

InvalidKeyException

InvalidArgumentException

putObject

public void putObject(String bucketName,
                      String objectName,
                      InputStream stream,
                      long size,
                      String contentType)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      InsufficientDataException

Uploads data from given stream as object to given bucket.

If the object is larger than 5MB, the client will automatically use a multipart session.

If the session fails, the user may attempt to re-upload the object by attempting to create the exact same object again. The client will examine all parts of any current upload session and attempt to reuse the session automatically. If a mismatch is discovered, the upload will fail before uploading any more data. Otherwise, it will resume uploading where the session left off.

If the multipart session fails, the user is responsible for resuming or removing the session.

Example:

 StringBuilder builder = new StringBuilder();
 for (int i = 0; i < 1000; i++) {
   builder.append("Sphinx of black quartz, judge my vow: Used by Adobe InDesign to display font samples. ");
   builder.append("(29 letters)\n");
   builder.append("Jackdaws love my big sphinx of quartz: Similarly, used by Windows XP for some fonts. ");
   builder.append("(31 letters)\n");
   builder.append("Pack my box with five dozen liquor jugs: According to Wikipedia, this one is used on ");
   builder.append("NASAs Space Shuttle. (32 letters)\n");
   builder.append("The quick onyx goblin jumps over the lazy dwarf: Flavor text from an Unhinged Magic Card. ");
   builder.append("(39 letters)\n");
   builder.append("How razorback-jumping frogs can level six piqued gymnasts!: Not going to win any brevity ");
   builder.append("awards at 49 letters long, but old-time Mac users may recognize it.\n");
   builder.append("Cozy lummox gives smart squid who asks for job pen: A 41-letter tester sentence for Mac ");
   builder.append("computers after System 7.\n");
   builder.append("A few others we like: Amazingly few discotheques provide jukeboxes; Now fax quiz Jack! my ");
   builder.append("brave ghost pled; Watch Jeopardy!, Alex Trebeks fun TV quiz game.\n");
   builder.append("---\n");
 }
 ByteArrayInputStream bais = new ByteArrayInputStream(builder.toString().getBytes("UTF-8"));
 // create object
 minioClient.putObject("my-bucketname", "my-objectname", bais, bais.available(), "application/octet-stream");
 bais.close();
 System.out.println("my-objectname is uploaded successfully");

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - stream to upload.; size - Size of all the data that will be uploaded.; contentType - Content type of the stream.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: putObject(String bucketName, String objectName, String fileName)

putObject

public void putObject(String bucketName,
                      String objectName,
                      InputStream stream,
                      long size,
                      Map<String,String> headerMap)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      InsufficientDataException

Uploads data from given stream as object to given bucket with specified meta data.

If the object is larger than 5MB, the client will automatically use a multipart session.

If the multipart session fails, the user is responsible for resuming or removing the session.

Example:

 StringBuilder builder = new StringBuilder();
 for (int i = 0; i < 1000; i++) {
   builder.append("Sphinx of black quartz, judge my vow: Used by Adobe InDesign to display font samples. ");
   builder.append("(29 letters)\n");
   builder.append("Jackdaws love my big sphinx of quartz: Similarly, used by Windows XP for some fonts. ");
   builder.append("(31 letters)\n");
   builder.append("Pack my box with five dozen liquor jugs: According to Wikipedia, this one is used on ");
   builder.append("NASAs Space Shuttle. (32 letters)\n");
   builder.append("The quick onyx goblin jumps over the lazy dwarf: Flavor text from an Unhinged Magic Card. ");
   builder.append("(39 letters)\n");
   builder.append("How razorback-jumping frogs can level six piqued gymnasts!: Not going to win any brevity ");
   builder.append("awards at 49 letters long, but old-time Mac users may recognize it.\n");
   builder.append("Cozy lummox gives smart squid who asks for job pen: A 41-letter tester sentence for Mac ");
   builder.append("computers after System 7.\n");
   builder.append("A few others we like: Amazingly few discotheques provide jukeboxes; Now fax quiz Jack! my ");
   builder.append("brave ghost pled; Watch Jeopardy!, Alex Trebeks fun TV quiz game.\n");
   builder.append("---\n");
 }
 ByteArrayInputStream bais = new ByteArrayInputStream(builder.toString().getBytes("UTF-8"));
 // create object
 Map<String, String> headerMap = new HashMap<>();
 headerMap.put("Content-Type", "application/octet-stream");
 minioClient.putObject("my-bucketname", "my-objectname", bais, bais.available(), headerMap);
 bais.close();
 System.out.println("my-objectname is uploaded successfully");

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - stream to upload.; size - Size of all the data that will be uploaded.; headerMap - Custom/additional meta data of the object.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: putObject(String bucketName, String objectName, String fileName)

putObject

public void putObject(String bucketName,
                      String objectName,
                      InputStream stream,
                      String contentType)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      InsufficientDataException

Uploads data from given stream as object to given bucket where the stream size is unknown.

If the stream has more than 525MiB data, the client uses a multipart session automatically.

If the multipart session fails, the user is responsible for resuming or removing the session.

Example:

 StringBuilder builder = new StringBuilder();
 for (int i = 0; i < 1000; i++) {
   builder.append("Sphinx of black quartz, judge my vow: Used by Adobe InDesign to display font samples. ");
   builder.append("(29 letters)\n");
   builder.append("Jackdaws love my big sphinx of quartz: Similarly, used by Windows XP for some fonts. ");
   builder.append("(31 letters)\n");
   builder.append("Pack my box with five dozen liquor jugs: According to Wikipedia, this one is used on ");
   builder.append("NASAs Space Shuttle. (32 letters)\n");
   builder.append("The quick onyx goblin jumps over the lazy dwarf: Flavor text from an Unhinged Magic Card. ");
   builder.append("(39 letters)\n");
   builder.append("How razorback-jumping frogs can level six piqued gymnasts!: Not going to win any brevity ");
   builder.append("awards at 49 letters long, but old-time Mac users may recognize it.\n");
   builder.append("Cozy lummox gives smart squid who asks for job pen: A 41-letter tester sentence for Mac ");
   builder.append("computers after System 7.\n");
   builder.append("A few others we like: Amazingly few discotheques provide jukeboxes; Now fax quiz Jack! my ");
   builder.append("brave ghost pled; Watch Jeopardy!, Alex Trebeks fun TV quiz game.\n");
   builder.append("---\n");
 }
 ByteArrayInputStream bais = new ByteArrayInputStream(builder.toString().getBytes("UTF-8"));
 // create object
 minioClient.putObject("my-bucketname", "my-objectname", bais, "application/octet-stream");
 bais.close();
 System.out.println("my-objectname is uploaded successfully");

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - stream to upload.; contentType - Content type of the stream.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: putObject(String bucketName, String objectName, String fileName)

putObject

public void putObject(String bucketName,
                      String objectName,
                      InputStream stream,
                      long size,
                      String contentType,
                      SecretKey key)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      NoSuchPaddingException,
                      IllegalBlockSizeException,
                      BadPaddingException,
                      InvalidAlgorithmParameterException

Uploads encrypted data from given stream as object to given bucket where data is encrypted on the fly using passed secret key.

If the object is larger than 5MB, the client will automatically use a multipart session.

Example:

  { @code StringBuilder builder = new StringBuilder(); for (int i = 0; i < 1000; i++) {
 builder.append("Sphinx of black quartz, judge my vow: Used by Adobe InDesign to display font samples. ");
 builder.append("(29 letters)\n");
 builder.append("Jackdaws love my big sphinx of quartz: Similarly, used by Windows XP for some fonts. ");
 builder.append("(31 letters)\n");
 builder.append("Pack my box with five dozen liquor jugs: According to Wikipedia, this one is used on ");
 builder.append("NASAs Space Shuttle. (32 letters)\n");
 builder.append("The quick onyx goblin jumps over the lazy dwarf: Flavor text from an Unhinged Magic Card. ");
 builder.append("(39 letters)\n");
 builder.append("How razorback-jumping frogs can level six piqued gymnasts!: Not going to win any brevity ");
 builder.append("awards at 49 letters long, but old-time Mac users may recognize it.\n");
 builder.append("Cozy lummox gives smart squid who asks for job pen: A 41-letter tester sentence for Mac ");
 builder.append("computers after System 7.\n");
 builder.append("A few others we like: Amazingly few discotheques provide jukeboxes; Now fax quiz Jack! my ");
 builder.append("brave ghost pled; Watch Jeopardy!, Alex Trebeks fun TV quiz game.\n"); builder.append("---\n"); }
 ByteArrayInputStream bais = new ByteArrayInputStream(builder.toString().getBytes("UTF-8"));

 // Generate symmetric 256 bit AES key. KeyGenerator symKeyGenerator = KeyGenerator.getInstance("AES");
 symKeyGenerator.init(256); SecretKey symKey = symKeyGenerator.generateKey();

 // create object minioClient.putObject("my-bucketname", "my-objectname", bais, bais.available(),
 "application/octet-stream", symKey); bais.close(); System.out.println("my-bucketname is uploaded successfully"); }

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - stream to upload.; size - Size of all the data that will be uploaded.; contentType - Content type of the stream.; key - Master key for encryption.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidAlgorithmParameterException - upon wrong encryption algorithm used; BadPaddingException - upon incorrect padding in a block; IllegalBlockSizeException - upon incorrect block; NoSuchPaddingException - upon wrong padding type specified; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: putObject(String bucketName, String objectName, String fileName, String contentType), putObject(String bucketName, String objectName, String fileName), putObject(String bucketName, String objectName, InputStream stream, long size, String contentType), putObject(String bucketName, String objectName, InputStream stream, long size, String contentType, KeyPair keypair)

putObject

public void putObject(String bucketName,
                      String objectName,
                      InputStream stream,
                      long size,
                      String contentType,
                      KeyPair keypair)
               throws InvalidBucketNameException,
                      NoSuchAlgorithmException,
                      InsufficientDataException,
                      IOException,
                      InvalidKeyException,
                      NoResponseException,
                      org.xmlpull.v1.XmlPullParserException,
                      ErrorResponseException,
                      InternalException,
                      InvalidArgumentException,
                      NoSuchPaddingException,
                      IllegalBlockSizeException,
                      BadPaddingException,
                      InvalidAlgorithmParameterException

Uploads encrypted data from given stream as object to given bucket where data is encrypted on the fly using passed keypair.

If the object is larger than 5MB, the client will automatically use a multipart session.

Example:

 {
   @code
   StringBuilder builder = new StringBuilder();
   for (int i = 0; i < 1000; i++) {
     builder.append("Sphinx of black quartz, judge my vow: Used by Adobe InDesign to display font samples. ");
     builder.append("(29 letters)\n");
     builder.append("Jackdaws love my big sphinx of quartz: Similarly, used by Windows XP for some fonts. ");
     builder.append("(31 letters)\n");
     builder.append("Pack my box with five dozen liquor jugs: According to Wikipedia, this one is used on ");
     builder.append("NASAs Space Shuttle. (32 letters)\n");
     builder.append("The quick onyx goblin jumps over the lazy dwarf: Flavor text from an Unhinged Magic Card. ");
     builder.append("(39 letters)\n");
     builder.append("How razorback-jumping frogs can level six piqued gymnasts!: Not going to win any brevity ");
     builder.append("awards at 49 letters long, but old-time Mac users may recognize it.\n");
     builder.append("Cozy lummox gives smart squid who asks for job pen: A 41-letter tester sentence for Mac ");
     builder.append("computers after System 7.\n");
     builder.append("A few others we like: Amazingly few discotheques provide jukeboxes; Now fax quiz Jack! my ");
     builder.append("brave ghost pled; Watch Jeopardy!, Alex Trebeks fun TV quiz game.\n");
     builder.append("---\n");
   }
   ByteArrayInputStream bais = new ByteArrayInputStream(builder.toString().getBytes("UTF-8"));

   KeyPairGenerator keyGenerator = KeyPairGenerator.getInstance("RSA");
   keyGenerator.initialize(1024, new SecureRandom());
   KeyPair keypair = keyGenerator.generateKeyPair();

   // create object
   minioClient.putObject("my-bucketname", "my-objectname", bais, bais.available(), "application/octet-stream",
       keypair);
   bais.close();
   System.out.println("my-bucketname is uploaded successfully");
 }

Parameters:: bucketName - Bucket name.; objectName - Object name to create in the bucket.; stream - stream to upload.; size - Size of all the data that will be uploaded.; contentType - Content type of the stream.; keypair - Master keypair for asymmetric encryption.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; InvalidAlgorithmParameterException - upon wrong encryption algorithm used; BadPaddingException - upon incorrect padding in a block; IllegalBlockSizeException - upon incorrect block; NoSuchPaddingException - upon wrong padding type specified; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException; InvalidArgumentException
See Also:: putObject(String bucketName, String objectName, String fileName, String contentType), putObject(String bucketName, String objectName, String fileName), putObject(String bucketName, String objectName, InputStream stream, long size, String contentType), putObject(String bucketName, String objectName, InputStream stream, long size, String contentType, SecretKey key)

getBucketPolicy

public PolicyType getBucketPolicy(String bucketName,
                                  String objectPrefix)
                           throws InvalidBucketNameException,
                                  InvalidObjectPrefixException,
                                  NoSuchAlgorithmException,
                                  InsufficientDataException,
                                  IOException,
                                  InvalidKeyException,
                                  NoResponseException,
                                  org.xmlpull.v1.XmlPullParserException,
                                  ErrorResponseException,
                                  InternalException

Get bucket policy at given objectPrefix

Parameters:

bucketName - Bucket name.

objectPrefix - name of the object prefix

Example:

 String policy = minioClient.getBucketPolicy("my-bucketname", "my-objectname");
 System.out.println(policy);

Throws:

InvalidBucketNameException

InvalidObjectPrefixException

NoSuchAlgorithmException

InsufficientDataException

IOException

InvalidKeyException

NoResponseException

org.xmlpull.v1.XmlPullParserException

ErrorResponseException

InternalException

setBucketPolicy

public void setBucketPolicy(String bucketName,
                            String objectPrefix,
                            PolicyType policyType)
                     throws InvalidBucketNameException,
                            InvalidObjectPrefixException,
                            NoSuchAlgorithmException,
                            InsufficientDataException,
                            IOException,
                            InvalidKeyException,
                            NoResponseException,
                            org.xmlpull.v1.XmlPullParserException,
                            ErrorResponseException,
                            InternalException

Set policy on bucket and object prefix.

Parameters:

bucketName - Bucket name.

objectPrefix - Name of the object prefix.

policyType - Enum of PolicyType.

Example:

 setBucketPolicy("my-bucketname", "my-objectname", PolicyType.READ_ONLY);

Throws:

InvalidBucketNameException

InvalidObjectPrefixException

NoSuchAlgorithmException

InsufficientDataException

IOException

InvalidKeyException

NoResponseException

org.xmlpull.v1.XmlPullParserException

ErrorResponseException

InternalException

getBucketNotification

public NotificationConfiguration getBucketNotification(String bucketName)
                                                throws InvalidBucketNameException,
                                                       InvalidObjectPrefixException,
                                                       NoSuchAlgorithmException,
                                                       InsufficientDataException,
                                                       IOException,
                                                       InvalidKeyException,
                                                       NoResponseException,
                                                       org.xmlpull.v1.XmlPullParserException,
                                                       ErrorResponseException,
                                                       InternalException

Get bucket notification configuration

Parameters:

bucketName - Bucket name.

Example:

 NotificationConfiguration notificationConfig = minioClient.getBucketNotification("my-bucketname");

Throws:

InvalidBucketNameException - upon invalid bucket name is given

NoResponseException - upon no response from server

IOException - upon connection error

org.xmlpull.v1.XmlPullParserException - upon parsing response xml

ErrorResponseException - upon unsuccessful execution

InternalException - upon internal library error

InvalidObjectPrefixException

NoSuchAlgorithmException

InsufficientDataException

InvalidKeyException

setBucketNotification

public void setBucketNotification(String bucketName,
                                  NotificationConfiguration notificationConfiguration)
                           throws InvalidBucketNameException,
                                  InvalidObjectPrefixException,
                                  NoSuchAlgorithmException,
                                  InsufficientDataException,
                                  IOException,
                                  InvalidKeyException,
                                  NoResponseException,
                                  org.xmlpull.v1.XmlPullParserException,
                                  ErrorResponseException,
                                  InternalException

Set bucket notification configuration

Parameters:

bucketName - Bucket name.

notificationConfiguration - Notification configuration to be set.

Example:

 minioClient.setBucketNotification("my-bucketname", notificationConfiguration);

Throws:

InvalidBucketNameException - upon invalid bucket name is given

NoResponseException - upon no response from server

IOException - upon connection error

org.xmlpull.v1.XmlPullParserException - upon parsing response xml

ErrorResponseException - upon unsuccessful execution

InternalException - upon internal library error

InvalidObjectPrefixException

NoSuchAlgorithmException

InsufficientDataException

InvalidKeyException

removeAllBucketNotification

public void removeAllBucketNotification(String bucketName)
                                 throws InvalidBucketNameException,
                                        InvalidObjectPrefixException,
                                        NoSuchAlgorithmException,
                                        InsufficientDataException,
                                        IOException,
                                        InvalidKeyException,
                                        NoResponseException,
                                        org.xmlpull.v1.XmlPullParserException,
                                        ErrorResponseException,
                                        InternalException

Remove all bucket notification.

Parameters:

bucketName - Bucket name.

Example:

 minioClient.removeAllBucketNotification("my-bucketname");

Throws:

InvalidBucketNameException - upon invalid bucket name is given

NoResponseException - upon no response from server

IOException - upon connection error

org.xmlpull.v1.XmlPullParserException - upon parsing response xml

ErrorResponseException - upon unsuccessful execution

InternalException - upon internal library error

InvalidObjectPrefixException

NoSuchAlgorithmException

InsufficientDataException

InvalidKeyException

listIncompleteUploads
```
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName)
                                               throws org.xmlpull.v1.XmlPullParserException
```
Lists incomplete uploads of objects in given bucket.

Parameters:

bucketName - Bucket name.

Returns:

an iterator of Upload.

Throws:

org.xmlpull.v1.XmlPullParserException

See Also:

listIncompleteUploads(String, String, boolean)

listIncompleteUploads
```
public Iterable<Result<Upload>> listIncompleteUploads(String bucketName,
                                                      String prefix)
                                               throws org.xmlpull.v1.XmlPullParserException
```
Lists incomplete uploads of objects in given bucket and prefix.

Parameters:

bucketName - Bucket name.

prefix - filters the list of uploads to include only those that start with prefix.

Returns:

an iterator of Upload.

Throws:

org.xmlpull.v1.XmlPullParserException

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>> myObjects = minioClient.listIncompleteUploads("my-bucketname");
 for (Result<Upload> result : myObjects) {
   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,
                                   NoSuchAlgorithmException,
                                   InsufficientDataException,
                                   IOException,
                                   InvalidKeyException,
                                   NoResponseException,
                                   org.xmlpull.v1.XmlPullParserException,
                                   ErrorResponseException,
                                   InternalException

Removes incomplete multipart upload of given object.

Example:

 minioClient.removeIncompleteUpload("my-bucketname", "my-objectname");
 System.out.println("successfully removed all incomplete upload session of my-bucketname/my-objectname");

Parameters:: bucketName - Bucket name.; objectName - Object name in the bucket.
Throws:: InvalidBucketNameException - upon invalid bucket name is given; NoResponseException - upon no response from server; IOException - upon connection error; org.xmlpull.v1.XmlPullParserException - upon parsing response xml; ErrorResponseException - upon unsuccessful execution; InternalException - upon internal library error; NoSuchAlgorithmException; InsufficientDataException; InvalidKeyException

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

See Also:

traceOn(java.io.OutputStream)

Class MinioClient

Service

Bucket

Object

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

setTimeout

ignoreCertCheck

setAppInfo

statObject

getObjectUrl

getObject

getObject

getObject

getObject

getObject

getObject

copyObject

copyObject

copyObject

copyObject

copyObject

presignedGetObject

presignedGetObject

presignedGetObject

presignedPutObject

presignedPutObject

presignedPostPolicy

removeObject

removeObject

listObjects

listObjects

listObjects

listObjects

listBuckets

bucketExists

makeBucket

makeBucket

removeBucket

putObject

putObject

putObject

putObject

putObject

putObject

putObject

getBucketPolicy

setBucketPolicy

getBucketNotification

setBucketNotification

removeAllBucketNotification

listIncompleteUploads

listIncompleteUploads

listIncompleteUploads

removeIncompleteUpload

traceOn

traceOff