Skip to content

fix doc: ObjectStat has been replaced by StatObjectResponse #1641

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

fix doc: ObjectStat has been replaced by StatObjectResponse #1641

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions docs/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1988,7 +1988,8 @@ minioClient.setObjectTags(

<a name="statObject"></a>
### statObject(StatObjectArgs args)
`public ObjectStat statObject(StatObjectArgs args)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#statObject-io.minio.StatObjectArgs-)_

`public StatObjectResponse statObject(StatObjectArgs args)` _[[Javadoc]](http://minio.github.io/minio-java/io/minio/MinioClient.html#statObject-io.minio.StatObjectArgs-)_

Gets object information and metadata of an object.

Expand All @@ -1997,19 +1998,19 @@ __Parameters__
|:----------|:-------------------|:------------|
| ``args`` | _[StatObjectArgs]_ | Arguments. |

| Returns |
|:------------------------------------------------------------|
| _[ObjectStat]_ - Populated object information and metadata. |
| Returns |
|:--------------------------------------------------------------------|
| _[StatObjectResponse]_ - Populated object information and metadata. |

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

// Get information of SSE-C encrypted object.
ObjectStat objectStat =
StatObjectResponse objectStat =
minioClient.statObject(
StatObjectArgs.builder()
.bucket("my-bucketname")
Expand All @@ -2018,7 +2019,7 @@ ObjectStat objectStat =
.build());

// Get information of a versioned object.
ObjectStat objectStat =
StatObjectResponse objectStat =
minioClient.statObject(
StatObjectArgs.builder()
.bucket("my-bucketname")
Expand All @@ -2027,7 +2028,7 @@ ObjectStat objectStat =
.build());

// Get information of a SSE-C encrypted versioned object.
ObjectStat objectStat =
StatObjectResponse objectStat =
minioClient.statObject(
StatObjectArgs.builder()
.bucket("my-bucketname")
Expand Down
20 changes: 10 additions & 10 deletions docs/zh_CN/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1118,23 +1118,23 @@ __参数__
| ``objectName`` | _String_ | 存储桶里的对象名称。 |


| 返回值类型 | 异常 |
|:--- |:--- |
| ``ObjectStat``: Populated object meta data. | 异常列表： |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |
| 返回值类型 | 异常 |
|:----------------------------------------------------|:--------------------------------------------------------|
| ``StatObjectResponse``: Populated object meta data. | 异常列表： |
| | ``InvalidBucketNameException`` : 不合法的存储桶名称。 |
| | ``NoResponseException`` : 服务器无响应。 |
| | ``IOException`` : 连接异常。 |
| | ``org.xmlpull.v1.XmlPullParserException`` : 解析返回的XML异常。 |
| | ``ErrorResponseException`` : 执行失败异常。 |
| | ``InternalException`` : 内部错误。 |

__示例__


```java
try {
// 获得对象的元数据。
ObjectStat objectStat = minioClient.statObject("mybucket", "myobject");
StatObjectResponse objectStat = minioClient.statObject("mybucket", "myobject");
System.out.println(objectStat);
} catch(MinioException e) {
System.out.println("Error occurred: " + e);
Expand Down