Obtaining an Online Decompression Policy (SDK for Java)
Function
This API is used to query the file decompression policy of a specified bucket. If the policy exists, a success message is returned with status code 200. For more information about online decompression, see Online Decompression.
If you have any questions during development, post them on the Issues page of GitHub.
Restrictions
- To configure, obtain, or delete online decompression policies, you must have the Tenant Administrator permission assigned by using role/policy-based authorization of IAM.
- Online decompression requires that you create an IAM agency to delegate OBS to access data in the bucket. The permissions the agency should assign to OBS include obs:object:PutObject, obs:object:GetObject, and obs:object:AbortMultipartUpload.
- The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.
Method
obsClient.getBucketCompressPolicy(GetBucketCompressPolicyRequest request)
Request Parameters
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| request | Yes | Explanation: Request parameters for obtaining the online decompression policy. For details, see Table 2. |
| Parameter | Type | Mandatory (Yes/No) | Description |
|---|---|---|---|
| bucketName | String | Yes | Explanation: Bucket name Restrictions:
Default value: None |
Responses
| Parameter | Type | Description |
|---|---|---|
| statusCode | int | Explanation: HTTP status code Value range: A status code is a group of digits indicating the status of a response. It ranges from 2xx (indicating successes) to 4xx or 5xx (indicating errors). For more information, see Status Code. Default value: None |
| responseHeaders | Map<String, Object> | Explanation: HTTP response header list, composed of tuples. In a tuple, the String key indicates the name of the header, and the Object value indicates the value of the header. Default value: None |
| compressPolicyConfiguration | Explanation: Number of policy rules. For details, see Table 4. |
| Parameter | Type | Description |
|---|---|---|
| rules | List<Table 5> | Explanation: Number of policy rules. For details, see Table 5. Restrictions: For the same bucket, prefixes of different rules cannot be the same or contain each other. The same agency is recommended. Value range: 1 to 10 Default value: None |
| Parameter | Type | Description |
|---|---|---|
| id | String | Explanation: Name of a decompression rule. It is the unique ID of the decompression rule configured for the current bucket, for example, event_0001. |
| project | String | Explanation: Project ID |
| agency | String | Explanation: IAM agency name |
| events | List<String> | Explanation: Trigger event type Value range: ["ObjectCreated:*"] ["ObjectCreated:Put"] ["ObjectCreated:Post"] ["ObjectCreated:Copy"] ["ObjectCreated:CompleteMultipartUpload"] |
| suffix | String | Explanation: Suffix defined in the rule |
| prefix | String | Explanation: Prefix defined in the rule |
| overwrite | int | Explanation: Method of processing a decompressed file if it has the same name as an existing file Value range:
|
| decompresspath | String | Explanation: Path for storing decompressed files |
| policytype | String | Explanation: Type of the decompression policy Value range: decompress |
Sample Code
import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.compress.CompressPolicyRule;
import com.obs.services.model.compress.GetBucketCompressPolicyRequest;
import com.obs.services.model.compress.GetBucketCompressPolicyResult;
public class GetBucketCompressPolicy {
public static void main(String[] args) {
// Obtain an AK/SK pair using environment variables or import the AK/SK pair in other ways. Using hard coding may result in leakage.
// Obtain an AK/SK pair on the management console.
String ak = System.getenv("ACCESS_KEY_ID");
String sk = System.getenv("SECRET_ACCESS_KEY_ID");
// (Optional) If you are using a temporary AK/SK pair and a security token to access OBS, you are not advised to use hard coding, which may result in information leakage.
// Obtain an AK/SK pair and a security token using environment variables or import them in other ways.
String securityToken = System.getenv("SECURITY_TOKEN");
// Enter the endpoint corresponding to the bucket. CN North-Beijing4 is used here as an example. Replace it with the one currently in use.
// Obtain an endpoint using environment variables or import it in other ways.
String endPoint = System.getenv("ENDPOINT");
ObsConfiguration obsConfiguration = new ObsConfiguration();
obsConfiguration.setEndPoint(endPoint);
ObsClient obsClient = new ObsClient(ak, sk, securityToken, obsConfiguration);
try {
String exampleBucket = "exampleBucket";
GetBucketCompressPolicyResult result =
obsClient.getBucketCompressPolicy(new GetBucketCompressPolicyRequest(exampleBucket));
System.out.println("GetBucketCompressPolicy successfully");
for (CompressPolicyRule rule : result.getCompressPolicyConfiguration().getRules()) {
System.out.println("Rule Id:"+ rule.getId());
System.out.println("Project Id:"+ rule.getProject());
System.out.println("Agency:"+ rule.getAgency());
System.out.println("Events:"+ rule.getEvents());
System.out.println("Prefix:"+ rule.getPrefix());
System.out.println("Suffix:"+ rule.getSuffix());
System.out.println("Overwrite:"+ rule.getOverwrite());
System.out.println("Decompress Path:"+ rule.getDecompresspath());
System.out.println("Policy Type:"+ rule.getPolicytype());
}
} catch (ObsException e) {
System.out.println("GetBucketCompressPolicy failed");
// Request failed. Print the HTTP status code.
System.out.println("HTTP Code:" + e.getResponseCode());
// Request failed. Print the server-side error code.
System.out.println("Error Code:" + e.getErrorCode());
// Request failed. Print the error details.
System.out.println("Error Message:" + e.getErrorMessage());
// Request failed. Print the request ID.
System.out.println("Request ID:" + e.getErrorRequestId());
System.out.println("Host ID:" + e.getErrorHostId());
e.printStackTrace();
} catch (Exception e) {
System.out.println("GetBucketCompressPolicy failed");
// Print other error information.
e.printStackTrace();
}
}
} Helpful Links
What is your overall rating for this page?
Thank you very much for your feedback. We will continue working to improve the documentation.See the reply and handling status in My Cloud VOC.
For any further questions, feel free to contact us through the chatbot.
Chatbot