Skip to main content

VolumeManager

A VolumeManager instance maintains a connection to Zilliz Cloud's Volume service. Before creating, listing, or deleting volumes, you need to initiate a VolumeManager instance.

io.milvus.bulkwriter.VolumeManager
📘Notes

A volume is an intermediate storage spot where you can hold your data for further processing, such as data merging, migration, or importing. For details, refer to Volume.

Constructor​

This constructor initializes a new VolumeManager instance designed to maintain a connection to Zilliz Cloud's Volume service.

VolumeManager(
    VolumeManagerParam.newBuilder()
        .withCloudEndpoint(String cloudEndpoint)
        .withApiKey(String apiKey)
        .build();
)

PARAMETERS:

  • cloudEndpoint (str) -

    [REQUIRED]

    The Zilliz Cloud endpoint, which is https:*//*api.cloud.zilliz.com (Global) or https://api.cloud.zilliz.com.cn (China), depending on the platform you have registered with.

  • apiKey (str) -

    [REQUIRED]

    Your Zilliz Cloud API key with sufficient permissions to manage volumes on Zilliz Cloud's Volume service. To obtain a Zilliz Cloud API key, follow the steps on API Keys.

RETURN TYPE:

VolumeManager

RETURNS:

A VolumeManager instance.

Examples​

import io.milvus.bulkwriter.VolumeManager;
import io.milvus.bulkwriter.VolumeManagerParam;

VolumeManagerParam volumeManagerParam = VolumeManagerParam.newBuilder()
    .withCloudEndpoint("https://api.cloud.zilliz.com")
    .withApiKey("YOUR_API_KEY")
    .build();
        
VolumeManager volumeManager = new VolumeManager(volumeManagerParam);