Obtaining an Inventory Rule (SDK for Java)

Function

This API returns an inventory rule (identified by configurationId) for the bucket.

If you have any questions during development, post them on the Issues page of GitHub.

Restrictions

To obtain a bucket inventory rule, you must be the bucket owner or have the required permission (obs:bucket:GetInventoryConfiguration in IAM or GetInventoryConfiguration in a bucket policy). For details, see Introduction to OBS Access Control, IAM Custom Policies, and Creating a Custom Bucket Policy.

The mapping between OBS regions and endpoints must comply with what is listed in Regions and Endpoints.

Method

obsClient.getInventoryConfiguration(GetInventoryConfigurationRequest request)

Request Parameters

**Table 1** GetInventoryConfigurationRequest
Parameter	Type	Mandatory (Yes/No)	Description
bucketName	String	Yes	Explanation: Bucket name. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None
configurationId	String	Yes	Explanation: ID of the inventory rule. Restrictions: The ID can be up to 64 bytes long and allows letters (a–z, A–Z), digits (0–9), hyphens (-), underscores (_), and periods (.). Default value: None

Responses

**Table 2** GetInventoryConfigurationResult
Parameter	Type	Description
statusCode	int	Explanation: HTTP status code. Value range: A status code is a group of digits that can be 2xx (indicating successes) or 4xx or 5xx (indicating errors). It indicates the status of a response. 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
inventoryConfiguration	InventoryConfiguration	Explanation: Bucket inventory configurations. For details, see Table 3.

**Table 3** InventoryConfiguration
Parameter	Type	Mandatory (Yes/No)	Description
configurationId	String	Yes	Explanation: ID of a bucket inventory rule. Restrictions: The rule ID allows letters (a–z, A–Z), digits (0–9), hyphens (-), underscores (_), and periods (.). Value range: The value can be up to 64 characters long. Default value: None
isEnabled	boolean	Yes	Explanation: Whether the bucket inventory rule is enabled. Value range: true: The rule is enabled, and an inventory file is generated. false: The rule is disabled. No inventory file is generated. Default value: true
objectPrefix	String	No	Explanation: Used to filter objects. Only objects with the specified name prefix are included in the inventory. Value range: The value must contain 1 to 1,024 characters. Default value: None
frequency	String	Yes	Explanation: Intervals when inventories are generated. You can set this parameter to Daily or Weekly. An inventory is generated within one hour from when it is configured for the first time. Then it is generated at the specified intervals. Value range: Daily: Inventories are generated once a day. Weekly: Inventories are generated once a week. Default value: None
inventoryFormat	String	Yes	Explanation: Inventory file format. Only the CSV format is supported. Value range: CSV Default value: None
destinationBucket	String	Yes	Explanation: Name of the bucket for storing inventories. Restrictions: A bucket name must be unique across all accounts and regions. A bucket name: Must be 3 to 63 characters long and start with a digit or letter. Lowercase letters, digits, hyphens (-), and periods (.) are allowed. Cannot be formatted as an IP address. Cannot start or end with a hyphen (-) or period (.). Cannot contain two consecutive periods (..), for example, my..bucket. Cannot contain periods (.) and hyphens (-) adjacent to each other, for example, my-.bucket or my.-bucket. If you repeatedly create buckets of the same name in the same region, no error will be reported and the bucket attributes comply with those set in the first creation request. Default value: None
inventoryPrefix	String	No	Explanation: The prefix of the inventory file name. Value range: The value must contain 1 to 1,024 characters. Default value: If you do not specify this parameter, BucketInventory is used as the prefix by default.
includedObjectVersions	String	Yes	Explanation: Whether versions of objects are included in an inventory. Value range: If this parameter is set to All, all the versions of objects are included in the inventory, and version-related fields are added to the inventory, including: VersionId, IsLatest, and DeleteMarker. If this parameter is set to Current, the inventory only lists information about the current object version and does not include any version-related fields. Default value: None
optionalFields	ArrayList<String>	No	Explanation: Additional object metadata fields that are contained in an inventory file. Value range: Size: Object size. LastModifiedDate: Last time when the object was modified. StorageClass: The storage class of the object. ETag: The ETag value of the object. IsMultipartUploaded: Whether the object was uploaded in a multipart upload. ReplicationStatus: The cross-region replication status of the object. EncryptionStatus: The encryption status of the object. Default value: None

Code Examples

This example returns the inventory rule whose ID is exampleConfigId001 for bucket example-bucket.

    
     
       
       
         import com.obs.services.ObsClient;
import com.obs.services.exception.ObsException;
import com.obs.services.model.inventory.GetInventoryConfigurationRequest;
import com.obs.services.model.inventory.GetInventoryConfigurationResult;
import com.obs.services.model.inventory.InventoryConfiguration;
public class GetInventoryConfiguration001
{
    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 advised not 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-Hong Kong is used here as an example. Replace it with the one in your actual situation.
        String endPoint = "https://obs.ap-southeast-1.myhuaweicloud.com";
        // Obtain an endpoint using environment variables or import it in other ways.
        // String endPoint = System.getenv("ENDPOINT");
        
        // Create an ObsClient instance.
        // Use the permanent AK/SK pair to initialize the client.
        ObsClient obsClient = new ObsClient(ak, sk,endPoint);
        // Use the temporary AK/SK pair and security token to initialize the client.
        // ObsClient obsClient = new ObsClient(ak, sk, securityToken, endPoint);

        try {
            // Set the following parameters.
            String exampleBucketName = "example-bucket";
            String exampleConfigurationId = "exampleConfigId001";
            GetInventoryConfigurationRequest request =
                    new GetInventoryConfigurationRequest(exampleBucketName, exampleConfigurationId);
            // Obtain the inventory rule.
            GetInventoryConfigurationResult result = obsClient.getInventoryConfiguration(request);
            InventoryConfiguration inventoryConfiguration = result.getInventoryConfiguration();
            // Print all parameters in the inventory rule.
            System.out.println("ConfigurationId:" + inventoryConfiguration.getConfigurationId());
            System.out.println("DestinationBucket:" + inventoryConfiguration.getDestinationBucket());
            System.out.println("InventoryFormat:" + inventoryConfiguration.getInventoryFormat());
            System.out.println("Enabled:" + inventoryConfiguration.getEnabled());
            System.out.println("Frequency:" + inventoryConfiguration.getFrequency());
            System.out.println("IncludedObjectVersions:" + inventoryConfiguration.getIncludedObjectVersions());
            System.out.println("InventoryPrefix:" + inventoryConfiguration.getInventoryPrefix());
            System.out.println("ObjectPrefix:" + inventoryConfiguration.getObjectPrefix());
            System.out.println("OptionalFields:" + inventoryConfiguration.getOptionalFields());
            // Print the HTTP status code.
            System.out.println("HTTP Code: " + result.getStatusCode());
            System.out.println("GetInventoryConfiguration succeeded");
        } catch (ObsException e) {
            System.out.println("GetInventoryConfiguration 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());
        } catch (Exception e) {
            System.out.println("GetInventoryConfiguration failed");
            // Print other error information.
            e.printStackTrace();
        }
    }
}

        

      

    
   