Find available regions (Java)
Gets a list of available regions for database creation.
The clients only return regions that support vector databases.
To return other regions, use a direct HTTP request with the region-type query parameter.
|
You need an application token with permission to create and configure databases, such as the Organization Administrator role. For more information, see Get endpoint and token. |
Result
Returns an AstraAvailableRegionInfo object that contains information about the available regions.
Parameters
Use the findAvailableRegions method, which belongs to the com.datastax.astra.client.admin.AstraDBAdmin class.
Method signature
List<AstraAvailableRegionInfo> findAvailableRegions(AstraFindAvailableRegionsOptions options)| Name | Type | Summary |
|---|---|---|
|
|
Optional.
The options for this method.
See Properties of |
| Name | Type | Summary |
|---|---|---|
|
|
Optional. Whether to only return regions that can be used by the caller’s organization. Default: true |
Examples
The following examples demonstrate how to find available regions.
import com.datastax.astra.client.DataAPIClient;
import com.datastax.astra.client.admin.AstraDBAdmin;
import com.datastax.astra.client.admin.commands.AstraAvailableRegionInfo;
import java.util.List;
public class Example {
public static void main(String[] args) {
DataAPIClient client = new DataAPIClient("APPLICATION_TOKEN");
AstraDBAdmin admin = client.getAdmin();
List<AstraAvailableRegionInfo> regions = admin.findAvailableRegions(null);
System.out.println(regions);
}
}Client reference
For more information, see the client reference.
