Metadata management (Java SDK V2)

Updated at:

This topic describes how to create, view, update, and delete the metadata table configurations of a bucket by using Java SDK V2, including the journal table configuration and the inventory table configuration.

Overview

Metadata management provides metadata table configuration capabilities for a bucket, including the following two types of configurations:

  • Journal table configuration (JournalTableConfiguration): Use RecordExpiration to control whether journal records are enabled (Expiration is set to ENABLED or DISABLED) and the record retention period (Days).

  • Inventory table configuration (InventoryTableConfiguration): Use ConfigurationState to control whether the inventory table is enabled (set to ENABLED or DISABLED), and optionally use EncryptionConfiguration to specify the encryption algorithm (SseAlgorithm).

Notes

  • The sample code in this topic uses the region ID cn-hangzhou of the China (Hangzhou) region. Replace it with the actual region as needed.

  • In this topic, access credentials are obtained from environment variables. Make sure that you have configured access credentials (AccessKey) before use.

  • Make sure that you have the permissions to perform metadata table configuration operations on the target bucket. By default, the bucket owner has these permissions. If you do not have the required permissions, contact the bucket owner to grant you the permissions.

  • You can also enable, modify, or disable metadata management in the OSS console.

Sample code

Create the metadata table configuration

The following code provides an example of how to create the metadata table configuration for a bucket (setting both the journal table and the inventory table).

import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.OSSClientBuilder;
import com.aliyun.sdk.service.oss2.credentials.CredentialsProvider;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.*;

public class CreateBucketMetadataConfigurationSample {
    public static void main(String[] args) {
        String region = "cn-hangzhou";
        String bucket = "examplebucket";

        CredentialsProvider provider = new EnvironmentVariableCredentialsProvider();
        OSSClientBuilder clientBuilder = OSSClient.newBuilder()
                .credentialsProvider(provider)
                .region(region);

        try (OSSClient client = clientBuilder.build()) {
            // Build the metadata configuration for log tables and inventory tables
            MetadataConfiguration configuration = MetadataConfiguration.newBuilder()
                    .journalTableConfiguration(JournalTableConfiguration.newBuilder()
                            .recordExpiration(MetadataTableRecordExpiration.newBuilder()
                                    .expiration("ENABLED")
                                    .days(30)
                                    .build())
                            .encryptionConfiguration(MetadataTableEncryptionConfiguration.newBuilder()
                                    .sseAlgorithm("AES256")
                                    .build())
                            .build())
                    .inventoryTableConfiguration(InventoryTableConfiguration.newBuilder()
                            .configurationState("ENABLED")
                            .encryptionConfiguration(MetadataTableEncryptionConfiguration.newBuilder()
                                    .sseAlgorithm("AES256")
                                    .build())
                            .build())
                    .build();

            CreateBucketMetadataConfigurationResult result = client.createBucketMetadataConfiguration(
                    CreateBucketMetadataConfigurationRequest.newBuilder()
                            .bucket(bucket)
                            .metadataConfiguration(configuration)
                            .build());
            System.out.printf("Status code:%d, request id:%s\n",
                    result.statusCode(), result.requestId());
        } catch (Exception e) {
            System.out.printf("error:\n%s", e);
        }
    }
}

View the metadata table configuration

The following code provides an example of how to view the metadata table configuration of a bucket.

import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.OSSClientBuilder;
import com.aliyun.sdk.service.oss2.credentials.CredentialsProvider;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.*;

public class GetBucketMetadataConfigurationSample {
    public static void main(String[] args) {
        String region = "cn-hangzhou";
        String bucket = "examplebucket";

        CredentialsProvider provider = new EnvironmentVariableCredentialsProvider();
        OSSClientBuilder clientBuilder = OSSClient.newBuilder()
                .credentialsProvider(provider)
                .region(region);

        try (OSSClient client = clientBuilder.build()) {
            GetBucketMetadataConfigurationResult result = client.getBucketMetadataConfiguration(
                    GetBucketMetadataConfigurationRequest.newBuilder()
                            .bucket(bucket)
                            .build());
            MetadataConfigurationResult configuration = result.metadataConfigurationResult();
            System.out.printf("Status code:%d, request id:%s\n",
                    result.statusCode(), result.requestId());
            System.out.printf("Table bucket ARN:%s, journal status:%s, inventory state:%s\n",
                    configuration.destinationResult().tableBucketArn(),
                    configuration.journalTableConfigurationResult().tableStatus(),
                    configuration.inventoryTableConfigurationResult().configurationState());
        } catch (Exception e) {
            System.out.printf("error:\n%s", e);
        }
    }
}

Update the inventory table configuration

The following code provides an example of how to update the inventory table configuration of a bucket.

import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.OSSClientBuilder;
import com.aliyun.sdk.service.oss2.credentials.CredentialsProvider;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.*;

public class UpdateBucketMetadataInventoryTableConfigurationSample {
    public static void main(String[] args) {
        String region = "cn-hangzhou";
        String bucket = "examplebucket";

        CredentialsProvider provider = new EnvironmentVariableCredentialsProvider();
        OSSClientBuilder clientBuilder = OSSClient.newBuilder()
                .credentialsProvider(provider)
                .region(region);

        try (OSSClient client = clientBuilder.build()) {
            // Enable or disable inventory tables
            InventoryTableConfiguration configuration = InventoryTableConfiguration.newBuilder()
                    .configurationState("ENABLED")
                    .build();
            UpdateBucketMetadataInventoryTableConfigurationResult result =
                    client.updateBucketMetadataInventoryTableConfiguration(
                            UpdateBucketMetadataInventoryTableConfigurationRequest.newBuilder()
                                    .bucket(bucket)
                                    .inventoryTableConfiguration(configuration)
                                    .build());
            System.out.printf("Status code:%d, request id:%s\n",
                    result.statusCode(), result.requestId());
        } catch (Exception e) {
            System.out.printf("error:\n%s", e);
        }
    }
}

Update the journal table configuration

The following code provides an example of how to update the journal table configuration of a bucket.

import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.OSSClientBuilder;
import com.aliyun.sdk.service.oss2.credentials.CredentialsProvider;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.*;

public class UpdateBucketMetadataJournalTableConfigurationSample {
    public static void main(String[] args) {
        String region = "cn-hangzhou";
        String bucket = "examplebucket";

        CredentialsProvider provider = new EnvironmentVariableCredentialsProvider();
        OSSClientBuilder clientBuilder = OSSClient.newBuilder()
                .credentialsProvider(provider)
                .region(region);

        try (OSSClient client = clientBuilder.build()) {
            // Update the expiration configuration of log tables
            JournalTableConfiguration configuration = JournalTableConfiguration.newBuilder()
                    .recordExpiration(MetadataTableRecordExpiration.newBuilder()
                            .expiration("ENABLED")
                            .days(30)
                            .build())
                    .build();
            UpdateBucketMetadataJournalTableConfigurationResult result =
                    client.updateBucketMetadataJournalTableConfiguration(
                            UpdateBucketMetadataJournalTableConfigurationRequest.newBuilder()
                                    .bucket(bucket)
                                    .journalTableConfiguration(configuration)
                                    .build());
            System.out.printf("Status code:%d, request id:%s\n",
                    result.statusCode(), result.requestId());
        } catch (Exception e) {
            System.out.printf("error:\n%s", e);
        }
    }
}

Delete the metadata table configuration

The following code provides an example of how to delete the metadata table configuration of a bucket.

import com.aliyun.sdk.service.oss2.OSSClient;
import com.aliyun.sdk.service.oss2.OSSClientBuilder;
import com.aliyun.sdk.service.oss2.credentials.CredentialsProvider;
import com.aliyun.sdk.service.oss2.credentials.EnvironmentVariableCredentialsProvider;
import com.aliyun.sdk.service.oss2.models.*;

public class DeleteBucketMetadataConfigurationSample {
    public static void main(String[] args) {
        String region = "cn-hangzhou";
        String bucket = "examplebucket";

        CredentialsProvider provider = new EnvironmentVariableCredentialsProvider();
        OSSClientBuilder clientBuilder = OSSClient.newBuilder()
                .credentialsProvider(provider)
                .region(region);

        try (OSSClient client = clientBuilder.build()) {
            DeleteBucketMetadataConfigurationResult result = client.deleteBucketMetadataConfiguration(
                    DeleteBucketMetadataConfigurationRequest.newBuilder()
                            .bucket(bucket)
                            .build());
            System.out.printf("Status code:%d, request id:%s\n",
                    result.statusCode(), result.requestId());
        } catch (Exception e) {
            System.out.printf("error:\n%s", e);
        }
    }
}

References