Package com.cockroachlabs.data.continuum.cloud

Interface CloudClient

All Known Implementing Classes:

HttpCloudClient, SimulatedCloudClient

public interface CloudClient

Client for the CockroachDB Cloud control-plane API (part of Cockroach Continuum): list clusters and configure metric export.

This is an optional, separate surface from the core transaction path. Like AegisClient, a SimulatedCloudClient is used whenever no API key is configured, so applications compile and run without a Continuum organization; set cockroachdb.continuum.cloud.api-key to target the real API (default base URL https://cockroachlabs.cloud/api/v1). Authentication uses a service-account secret key sent as a Bearer token.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final record	CloudClient.Cluster	A CockroachDB Cloud cluster (control-plane view).
static final record	CloudClient.MetricExportConfig	Metric-export configuration.
static enum	CloudClient.MetricExportTarget	A Cloud metric-export sink.
static final record	CloudClient.VirtualCluster	A Cockroach virtual cluster.

Method Summary

Modifier and Type	Method	Description
void	configureMetricExport(String clusterId, CloudClient.MetricExportConfig config)	Enables a metric-export sink for a cluster.
CloudClient.Cluster	getCluster(String clusterId)	Returns a single cluster by its control-plane ID.
List<CloudClient.Cluster>	listClusters()	Returns the clusters visible to the configured service account.

Method Details

listClusters

List<CloudClient.Cluster> listClusters()

Returns the clusters visible to the configured service account.

getCluster

CloudClient.Cluster getCluster(String clusterId)

Returns a single cluster by its control-plane ID.

configureMetricExport

void configureMetricExport(String clusterId,
 CloudClient.MetricExportConfig config)

Enables a metric-export sink for a cluster.