Skip to content

Commit 6c2afb3

Browse files
authored
Remove stale entries in API documentation (#1166)
1 parent e2482af commit 6c2afb3

File tree

1 file changed

+3
-95
lines changed

1 file changed

+3
-95
lines changed

docs/API.md

Lines changed: 3 additions & 95 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@ MinioClient minioClient =
4242
| [`getObjectLockConfiguration`](#getObjectLockConfiguration) | [`removeObjects`](#removeObjects) |
4343
| [`listBuckets`](#listBuckets) | [`selectObjectContent`](#selectObjectContent) |
4444
| [`listenBucketNotification`](#listenBucketNotification) | [`setObjectRetention`](#setObjectRetention) |
45-
| [`listIncompleteUploads`](#listIncompleteUploads) | [`setObjectTags`](#setObjectTags) |
46-
| [`makeBucket`](#makeBucket) | [`statObject`](#statObject) |
47-
| [`removeBucket`](#removeBucket) | [`uploadObject`](#uploadObject) |
48-
| [`removeIncompleteUpload`](#removeIncompleteUpload) | |
49-
| [`setBucketEncryption`](#setBucketEncryption) | |
45+
| [`makeBucket`](#makeBucket) | [`setObjectTags`](#setObjectTags) |
46+
| [`removeBucket`](#removeBucket) | [`statObject`](#statObject) |
47+
| [`setBucketEncryption`](#setBucketEncryption) | [`uploadObject`](#uploadObject) |
5048
| [`setBucketLifecycle`](#setBucketLifecycle) | |
5149
| [`setBucketNotification`](#setBucketNotification) | |
5250
| [`setBucketPolicy`](#setBucketPolicy) | |
@@ -630,74 +628,6 @@ try (CloseableIterator<Result<NotificationRecords>> ci =
630628
}
631629
```
632630

633-
<a name="listIncompleteUploads"></a>
634-
### listIncompleteUploads(ListIncompleteUploadsArgs args)
635-
`public Iterable<Result<Upload>> listIncompleteUploads(ListIncompleteUploadsArgs args)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#listIncompleteUploads-io.minio.ListIncompleteUploadsArgs-)_
636-
637-
Lists incomplete object upload information of a bucket.
638-
639-
__Parameters__
640-
641-
| Parameter | Type | Description |
642-
|:---------------|:-------------------------------|:---------------|
643-
| ``args`` | _[ListIncompleteUploadsArgs]_ | Arguments. |
644-
645-
| Returns |
646-
|:-----------------------------------------------------------------------------------|
647-
| _Iterable<[Result]<[Upload]>>_ - Lazy iterator contains object upload information. |
648-
649-
__Example__
650-
```java
651-
// Lists incomplete object upload information of a bucket.
652-
Iterable<Result<Upload>> results =
653-
minioClient.listIncompleteUploads(
654-
ListIncompleteUploadsArgs.builder().bucket("my-bucketname").build());
655-
for (Result<Upload> result : results) {
656-
Upload upload = result.get();
657-
System.out.println(upload.uploadId() + ", " + upload.objectName());
658-
}
659-
660-
// Lists incomplete object upload information of a bucket for prefix.
661-
Iterable<Result<Upload>> results =
662-
minioClient.listIncompleteUploads(
663-
ListIncompleteUploadsArgs.builder()
664-
.bucket("my-bucketname")
665-
.prefix("my-obj")
666-
.build());
667-
for (Result<Upload> result : results) {
668-
Upload upload = result.get();
669-
System.out.println(upload.uploadId() + ", " + upload.objectName());
670-
}
671-
672-
// Lists incomplete object upload information of a bucket for prefix recursively.
673-
Iterable<Result<Upload>> results =
674-
minioClient.listIncompleteUploads(
675-
ListIncompleteUploadsArgs.builder()
676-
.bucket("my-bucketname")
677-
.prefix("my-obj")
678-
.recursive(true)
679-
.build());
680-
for (Result<Upload> result : results) {
681-
Upload upload = result.get();
682-
System.out.println(upload.uploadId() + ", " + upload.objectName());
683-
}
684-
685-
// Lists incomplete object upload information of a bucket for prefix, delimiter.
686-
// uploadIdMarker and maxUpload to 500
687-
Iterable<Result<Upload>> results =
688-
minioClient.listIncompleteUploads(
689-
ListIncompleteUploadsArgs.builder()
690-
.bucket("my-bucketname")
691-
.prefix("my-obj")
692-
.delimiter("-")
693-
.maxUploads(500)
694-
.uploadIdMarker("Xgw4MJT6ZPAVxpY0SAuGN7q4uWJJM22ZYg1W99trdp4tpO88")
695-
.build());
696-
for (Result<Upload> result : results) {
697-
Upload upload = result.get();
698-
System.out.println(upload.uploadId() + ", " + upload.objectName());
699-
```
700-
701631
<a name="listObjects"></a>
702632
### listObjects(ListObjectsArgs args)
703633
`public Iterable<Result<Item>> listObjects(ListObjectsArgs args)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#listObjects-io.minio.ListObjectsArgs-)_
@@ -797,26 +727,6 @@ __Example__
797727
minioClient.removeBucket(RemoveBucketArgs.builder().bucket(bucketName).build());
798728
```
799729

800-
<a name="removeIncompleteUpload"></a>
801-
### removeIncompleteUpload(RemoveIncompleteUploadArgs args)
802-
`public void removeIncompleteUpload(String bucketName, String objectName)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#removeIncompleteUpload-io.minio.RemoveIncompleteUploadArgs-)_
803-
804-
Removes incomplete uploads of an object.
805-
806-
__Parameters__
807-
| Parameter | Type | Description |
808-
|:-----------------|:-------------------------------|:-----------------------------|
809-
| ``args`` | _[RemoveIncompleteUploadArgs]_ | Arguments. |
810-
811-
__Example__
812-
```java
813-
minioClient.removeIncompleteUpload(
814-
RemoveIncompleteUploadArgs.builder()
815-
.bucket("my-bucketname")
816-
.object("my-objectname")
817-
.build());
818-
```
819-
820730
<a name="setBucketEncryption"></a>
821731
### setBucketEncryption(SetBucketEncryptionArgs args)
822732
`public void setBucketEncryption(SetBucketEncryptionArgs args)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#setBucketEncryption-io.minio.SetBucketEncryptionArgs-)_
@@ -1904,11 +1814,9 @@ ObjectStat objectStat =
19041814
[GetObjectLockConfigurationArgs]: http://minio.github.io/minio-java/io/minio/GetObjectLockConfigurationArgs.html
19051815
[SetObjectLockConfigurationArgs]: http://minio.github.io/minio-java/io/minio/SetObjectLockConfigurationArgs.html
19061816
[DeleteObjectLockConfigurationArgs]: http://minio.github.io/minio-java/io/minio/DeleteObjectLockConfigurationArgs.html
1907-
[RemoveIncompleteUploadArgs]: http://minio.github.io/minio-java/io/minio/RemoveIncompleteUploadArgs.html
19081817
[GetPresignedObjectUrlArgs]: http://minio.github.io/minio-java/io/minio/GetPresignedObjectUrlArgs.html
19091818
[RemoveObjectsArgs]: http://minio.github.io/minio-java/io/minio/RemoveObjectsArgs.html
19101819
[CopyObjectArgs]: http://minio.github.io/minio-java/io/minio/CopyObjectArgs.html
1911-
[ListIncompleteUploadsArgs]: http://minio.github.io/minio-java/io/minio/ListIncompleteUploadsArgs.html
19121820
[PutObjectArgs]: http://minio.github.io/minio-java/io/minio/PutObjectArgs.html
19131821
[UploadObjectArgs]: http://minio.github.io/minio-java/io/minio/UploadObjectArgs.html
19141822
[ComposeObjectArgs]: http://minio.github.io/minio-java/io/minio/ComposeObjectArgs.html

0 commit comments

Comments
 (0)