This document provides an overview of APIs and SDK code samples related to listing objects.
API | Operation Name | Description |
---|---|---|
GET Bucket (List Objects) | Querying an object list | Queries some or all objects in a bucket |
GET Bucket Object Versions | Querying a list of objects and their version history | Queries some or all objects in bucket and their version history |
For the parameters and method descriptions of all the APIs in the SDK, please see SDK API Reference.
This API is used to query some or all objects in a bucket.
String bucketName = "examplebucket-1250000000"; // Format: BucketName-APPID
final GetBucketRequest getBucketRequest = new GetBucketRequest(bucketName);
// Prefix match, which is used to specify the address prefix of the returned objects
getBucketRequest.setPrefix("dir/");
// Maximum number of entries returned at a time. Default value: 1,000
getBucketRequest.setMaxKeys(100);
cosXmlService.getBucketAsync(getBucketRequest, new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult result) {
GetBucketResult getBucketResult = (GetBucketResult) result;
if (getBucketResult.listBucket.isTruncated) {
// The data is truncated, and the next page of data needs to be pulled
prevPageResult = getBucketResult;
}
}
@Override
public void onFail(CosXmlRequest cosXmlRequest,
CosXmlClientException clientException,
CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
Note:
For more samples, please visit GitHub.
String bucketName = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketRequest getBucketRequest = new GetBucketRequest(bucketName);
// Prefix match, which is used to specify the address prefix of the returned objects
getBucketRequest.setPrefix("dir/");
// `prevPageResult` is the result returned on the previous page, where `nextMarker` indicates the starting point of the next page
String nextMarker = prevPageResult.listBucket.nextMarker;
getBucketRequest.setMarker(nextMarker);
// Maximum number of entries returned at a time. Default value: 1,000
getBucketRequest.setMaxKeys(100);
cosXmlService.getBucketAsync(getBucketRequest, new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult result) {
GetBucketResult getBucketResult = (GetBucketResult) result;
if (getBucketResult.listBucket.isTruncated) {
// The data is truncated, and the next page of data needs to be pulled
}
}
@Override
public void onFail(CosXmlRequest cosXmlRequest,
CosXmlClientException clientException,
CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
Note:
For more samples, please visit GitHub.
String bucketName = "examplebucket-1250000000"; // Format: BucketName-APPID
GetBucketRequest getBucketRequest = new GetBucketRequest(bucketName);
// Prefix match, which is used to specify the address prefix of the returned objects
getBucketRequest.setPrefix("dir/");
// Maximum number of entries returned at a time. Default value: 1,000
getBucketRequest.setMaxKeys(100);
// The delimiter is a symbol. If the prefix exists,
// identical paths between the prefix and delimiter will be grouped as together and defined as a common prefix,
// and then all common prefixes will be listed; otherwise, the listing will start from the beginning of the path
getBucketRequest.setDelimiter("/");
cosXmlService.getBucketAsync(getBucketRequest, new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult result) {
GetBucketResult getBucketResult = (GetBucketResult) result;
}
@Override
public void onFail(CosXmlRequest cosXmlRequest,
CosXmlClientException clientException,
CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
Note:
For more samples, please visit GitHub.
This API is used to query some or all objects in a versioning-enabled bucket.
String bucketName = "examplebucket-1250000000"; // Format: BucketName-APPID
final GetBucketObjectVersionsRequest getBucketRequest =
new GetBucketObjectVersionsRequest(bucketName);
// Prefix match, which is used to specify the address prefix of the returned objects
getBucketRequest.setPrefix("dir/");
// Maximum number of entries returned at a time. Default value: 1,000
getBucketRequest.setMaxKeys(100);
cosXmlService.getBucketObjectVersionsAsync(getBucketRequest,
new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult result) {
GetBucketObjectVersionsResult getBucketResult =
(GetBucketObjectVersionsResult) result;
if (getBucketResult.listVersionResult.isTruncated) {
// The data is truncated, and the next page of data needs to be pulled
prevPageResult = getBucketResult;
}
}
@Override
public void onFail(CosXmlRequest cosXmlRequest,
CosXmlClientException clientException,
CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
Note:
For more samples, please visit GitHub .
String bucketName = "examplebucket-1250000000"; // Format: BucketName-APPID
final GetBucketObjectVersionsRequest getBucketRequest =
new GetBucketObjectVersionsRequest(bucketName);
// Prefix match, which is used to specify the address prefix of the returned objects
getBucketRequest.setPrefix("dir/");
// Maximum number of entries returned at a time. Default value: 1,000
getBucketRequest.setMaxKeys(100);
// `prevPageResult` is the result returned on the previous page, where `nextMarker` and `nextVersionIdMarker`
// indicate the starting point of the next page
getBucketRequest.setKeyMarker(prevPageResult.listVersionResult
.nextKeyMarker);
getBucketRequest.setVersionIdMarker(prevPageResult.listVersionResult
.nextVersionIdMarker);
cosXmlService.getBucketObjectVersionsAsync(getBucketRequest,
new CosXmlResultListener() {
@Override
public void onSuccess(CosXmlRequest request, CosXmlResult result) {
GetBucketObjectVersionsResult getBucketResult =
(GetBucketObjectVersionsResult) result;
if (getBucketResult.listVersionResult.isTruncated) {
// The data is truncated, and the next page of data needs to be pulled
prevPageResult = getBucketResult;
}
}
@Override
public void onFail(CosXmlRequest cosXmlRequest,
CosXmlClientException clientException,
CosXmlServiceException serviceException) {
if (clientException != null) {
clientException.printStackTrace();
} else {
serviceException.printStackTrace();
}
}
});
Note:
For more samples, please visit GitHub.
Was this page helpful?