Skip to content

fix docs #1644

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/gradle.yml
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ jobs:
run: |
echo "DEV_VERSION=$(./gradlew properties | awk '/^version:/ { print $2 }')" >> $GITHUB_ENV
echo "RELEASE_VERSION=$(./gradlew properties -Prelease | awk '/^version:/ { print $2 }')" >> $GITHUB_ENV
- name: Gradle build on Ununtu
- name: Gradle build on Ubuntu
if: matrix.os == 'ubuntu-latest'
run: |
./gradlew build
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/ComposeSource.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@
import io.minio.errors.InternalException;
import java.util.Objects;

/** A source object defintion for {@link ComposeObjectArgs}. */
/** A source object definition for {@link ComposeObjectArgs}. */
public class ComposeSource extends ObjectConditionalReadArgs {
private Long objectSize = null;
private Multimap<String, String> headers = null;
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/CopySource.java
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@

package io.minio;

/** A source object defintion for {@link CopyObjectArgs}. */
/** A source object definition for {@link CopyObjectArgs}. */
public class CopySource extends ObjectConditionalReadArgs {
protected CopySource() {}

Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/S3Base.java
Original file line number Diff line number Diff line change
Expand Up @@ -477,7 +477,7 @@ protected Headers httpHeaders(Multimap<String, String> headerMap) {
return builder.build();
}

/** Create HTTP request for given paramaters. */
/** Create HTTP request for given parameters. */
protected Request createRequest(
HttpUrl url, Method method, Headers headers, Object body, int length, Credentials creds)
throws InsufficientDataException, InternalException, IOException, NoSuchAlgorithmException {
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/credentials/Provider.java
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
public interface Provider {
/**
* Returns a valid {@link Credentials} instance by retrieving from credential provider service if
* neccessary.
* necessary.
*/
Credentials fetch();
}
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ public ErrorResponseException(ErrorResponse errorResponse, Response response, St
this.response = response;
}

/** Returns ErrorResponse contains detail of what error occured. */
/** Returns ErrorResponse contains detail of what error occurred. */
public ErrorResponse errorResponse() {
return this.errorResponse;
}
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/errors/InternalException.java
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package io.minio.errors;

/**
* Thrown to indicate that unexpected internal library error occured while processing given request.
* Thrown to indicate that unexpected internal library error occurred while processing given request.
*/
public class InternalException extends MinioException {
private static final long serialVersionUID = 138336287983212416L;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ public class CompleteMultipartUpload {
@ElementList(name = "Part", inline = true)
private List<Part> partList;

/** Constucts a new CompleteMultipartUpload object with given parts. */
/** Constructs a new CompleteMultipartUpload object with given parts. */
public CompleteMultipartUpload(@Nonnull Part[] parts) throws IllegalArgumentException {
if (Objects.requireNonNull(parts, "parts must not be null").length == 0) {
throw new IllegalArgumentException("parts cannot be empty");
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/messages/Initiator.java
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@
import org.simpleframework.xml.Root;

/**
* Helper class to denote Initator information of a multipart upload and used in {@link
* Helper class to denote Initiator information of a multipart upload and used in {@link
* ListMultipartUploadsResult} and {@link ListPartsResult}.
*/
@Root(name = "Initiator", strict = false)
Expand Down
2 changes: 1 addition & 1 deletion api/src/main/java/io/minio/messages/ListPartsResult.java
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ public String storageClass() {
return storageClass;
}

/** Returns initator information. */
/** Returns initiator information. */
public Initiator initiator() {
return initiator;
}
Expand Down
4 changes: 2 additions & 2 deletions api/src/main/java/io/minio/messages/Upload.java
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ public String uploadId() {
return uploadId;
}

/** Returns initator information. */
/** Returns initiator information. */
public Initiator initiator() {
return initiator;
}
Expand All @@ -83,7 +83,7 @@ public String storageClass() {
return storageClass;
}

/** Returns initated time. */
/** Returns initiated time. */
public ZonedDateTime initiated() {
return initiated.zonedDateTime();
}
Expand Down
6 changes: 3 additions & 3 deletions docs/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@ MinioClient s3Client =
MinioClient s3Client =
MinioClient.builder()
.endpoint("s3.amazonaws.com", 443, true)
.credentials("YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY").
.credentials("YOUR-ACCESSKEYID", "YOUR-SECRETACCESSKEY")
.region("eu-west-2")
.build();

Expand Down Expand Up @@ -1259,7 +1259,7 @@ Enables legal hold on an object.

| Parameter | Type | Description |
|:---------------|:------------------------------|:-------------|
| ``args`` | _[EnableObjectLegalHoldArgs]_ | Argumments. |
| ``args`` | _[EnableObjectLegalHoldArgs]_ | Arguments. |

__Example__
```java
Expand Down Expand Up @@ -1378,7 +1378,7 @@ __Parameters__

| Returns |
|:-------------------------------------------|
| _[GetObjectAttributesResponse]_ - Respone. |
| _[GetObjectAttributesResponse]_ - Response. |

__Example__
```java
Expand Down
82 changes: 41 additions & 41 deletions docs/zh_CN/API.md
Original file line number Diff line number Diff line change
Expand Up @@ -721,20 +721,20 @@ __参数__
| ``objectName`` | _String_ | 存储桶里的对象名称。 |
| ``key`` | _SecretKey_ | [SecretKey](https://docs.oracle.com/javase/7/docs/api/javax/crypto/SecretKey.html)类型的数据。|

| 返回值类型 | 异常 |
|:--- |:--- |
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
| | ``BadPaddingException`` : 错误的padding |
| | ``IllegalBlockSizeException`` : 不正确的block size |
| | ``NoSuchPaddingException`` : 错误的pading类型 |
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
| 返回值类型 | 异常 |
|:--- |:--------------------------------------------------------|
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
| | ``BadPaddingException`` : 错误的padding |
| | ``IllegalBlockSizeException`` : 不正确的block size |
| | ``NoSuchPaddingException`` : 错误的padding类型 |
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |

__示例__

Expand Down Expand Up @@ -787,20 +787,20 @@ __参数__
| ``objectName`` | _String_ | 存储桶里的对象名称。 |
| ``key`` | _KeyPair_ | RSA [KeyPair](https://docs.oracle.com/javase/7/docs/api/java/security/KeyPair.html)类型的对象。 |

| 返回值类型 | 异常 |
|:--- |:--- |
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
| | ``BadPaddingException`` : 错误的padding |
| | ``IllegalBlockSizeException`` : 不正确的block size |
| | ``NoSuchPaddingException`` : 错误的pading类型 |
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |
| 返回值类型 | 异常 |
|:--- |:--------------------------------------------------------|
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidEncryptionMetadataException`` : 加密秘钥错误。 |
| | ``BadPaddingException`` : 错误的padding |
| | ``IllegalBlockSizeException`` : 不正确的block size |
| | ``NoSuchPaddingException`` : 错误的padding类型 |
| | ``InvalidAlgorithmParameterException`` : 该算法不存在 |

__示例__

Expand Down Expand Up @@ -1045,19 +1045,19 @@ __参数__
| ``contentType`` | _String_ | Content type。 |
| ``key`` | _KeyPair_ | 一个RSA [KeyPair](https://docs.oracle.com/javase/7/docs/api/java/security/KeyPair.html)的对象。 |

| 返回值类型 | 异常 |
|:--- |:--- |
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidAlgorithmParameterException`` : 错误的加密算法。 |
| | ``BadPaddingException`` : 不正确的padding。 |
| | ``IllegalBlockSizeException`` : 不正确的block。 |
| | ``NoSuchPaddingException`` : 错误的pading类型。 |
| 返回值类型 | 异常 |
|:--- |:--------------------------------------------------------|
| None | 异常列表: |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| | ``InvalidAlgorithmParameterException`` : 错误的加密算法。 |
| | ``BadPaddingException`` : 不正确的padding。 |
| | ``IllegalBlockSizeException`` : 不正确的block。 |
| | ``NoSuchPaddingException`` : 错误的padding类型。 |

__示例__

Expand Down
2 changes: 1 addition & 1 deletion examples/GetObjectRetention.java
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ public static void main(String[] args)
.build());

System.out.println("Mode: " + retention.mode());
System.out.println("Retainuntil Date: " + retention.retainUntilDate());
System.out.println("Retain until Date: " + retention.retainUntilDate());
} catch (MinioException e) {
System.out.println("Error occurred: " + e);
}
Expand Down
2 changes: 1 addition & 1 deletion examples/ListBuckets.java
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ public static void main(String[] args)
// .credentials("YOUR-ACCESSKEY", "YOUR-SECRETACCESSKEY")
// .build();

// List buckets we have atleast read access.
// List buckets we have at least read access.
Iterable<Result<Bucket>> results = minioClient.listBuckets(ListBucketsArgs.builder().build());
for (Result<Bucket> result : results) {
Bucket bucket = result.get();
Expand Down
2 changes: 1 addition & 1 deletion examples/MakeBucket.java
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,7 @@ public static void main(String[] args)
// .credentials("YOUR-ACCESSKEY", "YOUR-SECRETACCESSKEY")
// .build();

// Create bucket 'my-bucketname' if it doesn`t exist.
// Create bucket 'my-bucketname' if it doesn't exist.
if (!minioClient.bucketExists(BucketExistsArgs.builder().bucket("my-bucketname").build())) {
minioClient.makeBucket(MakeBucketArgs.builder().bucket("my-bucketname").build());
System.out.println("my-bucketname is created successfully");
Expand Down