Package com.linkedin.venice.controllerapi

Class ControllerClient

java.lang.Object

com.linkedin.venice.controllerapi.ControllerClient

All Implemented Interfaces:

Closeable, AutoCloseable

Direct Known Subclasses:

D2ControllerClient

public class ControllerClient
extends Object
implements Closeable

Constructor Summary

Constructors

Constructor	Description
ControllerClient(String clusterName, String discoveryUrls)
ControllerClient(String clusterName, String discoveryUrls, Optional<SSLFactory> sslFactory)

Method Summary

Modifier and Type	Method	Description
StoreMigrationResponse	abortMigration(String storeName, String destClusterName)	This command should be sent to src controller, not dest controller
SchemaResponse	addDerivedSchema(String storeName, int valueSchemaId, String derivedSchemaStr)
SchemaResponse	addDerivedSchema(String storeName, int valueSchemaId, String derivedSchemaStr, int derivedSchemaId)
ControllerResponse	addNodeIntoAllowList(String instanceId)
SchemaResponse	addValueSchema(String storeName, String valueSchemaStr)
SchemaResponse	addValueSchema(String storeName, String valueSchemaStr, int valueSchemaId)
SchemaResponse	addValueSchema(String storeName, String valueSchemaStr, int valueSchemaId, DirectionalSchemaCompatibilityType schemaCompatType)
VersionResponse	addVersionAndStartIngestion(String storeName, String pushJobId, int version, int partitionCount, Version.PushType pushType, String remoteKafkaBootstrapServers, long rewindTimeInSecondsOverride, int replicationMetadataVersionId)	Used for store migration to add version and start ingestion in destination cluster for new pushes in the source cluster during the ingestion.
ControllerResponse	checkResourceCleanupForStoreCreation(String storeName)
MultiStoreTopicsResponse	cleanupInstanceCustomizedStates()
void	close()
StoreComparisonResponse	compareStore(String storeName, String fabricA, String fabricB)
StoreMigrationResponse	completeMigration(String storeName, String destClusterName)
ControllerResponse	configureActiveActiveReplicationForCluster(boolean enableActiveActiveReplication, String storeType, Optional<String> regionsFilter)
static ControllerClient	constructClusterControllerClient(String clusterName, String discoveryUrls)	Deprecated. Use ControllerClientFactory.getControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>)
static ControllerClient	constructClusterControllerClient(String clusterName, String discoveryUrls, Optional<SSLFactory> sslFactory)	Deprecated. Use ControllerClientFactory.getControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>)
StoreResponse	copyOverStoreMetadata(String sourceFabric, String destFabric, String storeName)
NewStoreResponse	createNewStore(String storeName, String owner, String keySchema, String valueSchema)
NewStoreResponse	createNewStore(String storeName, String owner, String keySchema, String valueSchema, String accessPermissions)
ControllerResponse	createNewStoreWithParameters(String storeName, String owner, String keySchema, String valueSchema, UpdateStoreQueryParams updateStoreQueryParams)	Simplified API that wraps together the store create and update functionalities with some clean up functionality
NewStoreResponse	createNewSystemStore(String storeName, String owner, String keySchema, String valueSchema)
ControllerResponse	createStoragePersona(String name, long quota, Set<String> storesToEnforce, Set<String> owners)
ControllerResponse	dataRecovery(String sourceFabric, String destinationFabric, String storeName, int versionNumber, boolean sourceVersionIncluded, boolean copyAllVersionConfigs, Optional<Version> sourceVersion)
AclResponse	deleteAclForStore(String storeName)
MultiVersionResponse	deleteAllVersions(String storeName)
ControllerResponse	deleteKafkaTopic(String topicName)
VersionResponse	deleteOldVersion(String storeName, int versionNum)
ControllerResponse	deleteStoragePersona(String name)
TrackableControllerResponse	deleteStore(String storeName)
ControllerResponse	deleteValueSchemas(String storeName, List<String> schemaIds)
ControllerResponse	disableAndDeleteStore(String storeName)
static ControllerClient	discoverAndConstructControllerClient(String storeName, String discoveryUrls, Optional<SSLFactory> sslFactory, int retryAttempts)	Deprecated. Use ControllerClientFactory.discoverAndConstructControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>, int)
D2ServiceDiscoveryResponse	discoverCluster(String storeName)
static D2ServiceDiscoveryResponse	discoverCluster(String discoveryUrls, String storeName, Optional<SSLFactory> sslFactory, int retryAttempts)
protected String	discoverLeaderController()
VersionCreationResponse	emptyPush(String storeName, String pushJobId, long storeSize)
ControllerResponse	enableMaxCapacityProtection(boolean isMaxCapacityProtection)
ControllerResponse	enableQuotaRebalanced(boolean isQuotaRebalanced, int expectRouterCount)
ControllerResponse	enableStoreReads(String storeName, boolean enable)
ControllerResponse	enableStoreReadWrites(String storeName, boolean enable)
ControllerResponse	enableStoreWrites(String storeName, boolean enable)
ControllerResponse	enableThrottling(boolean isThrottlingEnabled)
protected static String	encodeQueryParams(QueryParams params)
AclResponse	getAclForStore(String storeName)
AdminCommandExecutionResponse	getAdminCommandExecution(long executionId)
AdminTopicMetadataResponse	getAdminTopicMetadata(Optional<String> storeName)
StoppableNodeStatusResponse	getAggregatedHealthStatus(String clusterName, List<String> instances, List<String> toBeStoppedInstances)
MultiSchemaResponse	getAllReplicationMetadataSchemas(String storeName)
MultiSchemaResponse	getAllValueAndDerivedSchema(String storeName)
MultiSchemaResponse	getAllValueSchema(String storeName)
MultiStoreStatusResponse	getBackupVersions(String clusterName, String storeName)
String	getClusterName()
ClusterStaleDataAuditResponse	getClusterStaleStores(String clusterName, String parentControllerUrl)
MultiStoragePersonaResponse	getClusterStoragePersonas()
MultiStoreInfoResponse	getClusterStores(String clusterName)
Collection<String>	getControllerDiscoveryUrls()
MultiStoreTopicsResponse	getDeletableStoreTopics()
MultiStoreStatusResponse	getFutureVersions(String clusterName, String storeName)
SystemStoreHeartbeatResponse	getHeartbeatFromSystemStore(String storeName)
SchemaUsageResponse	getInUseSchemaIds(String storeName)
PubSubTopicConfigResponse	getKafkaTopicConfigs(String kafkaTopicName)
SchemaResponse	getKeySchema(String storeName)
LastSucceedExecutionIdResponse	getLastSucceedExecutionId()
String	getLeaderControllerUrl()
MigrationPushStrategyResponse	getMigrationPushStrategies()
protected static QueryParams	getQueryParamsToDiscoverCluster(String storeName)
RegionPushDetailsResponse	getRegionPushDetails(String storeName, boolean isPartitionDetailEnabled)
RepushInfoResponse	getRepushInfo(String storeName, Optional<String> fabricName)
RoutersClusterConfigResponse	getRoutersClusterConfig()
StorageEngineOverheadRatioResponse	getStorageEngineOverheadRatio(String storeName)
StoragePersonaResponse	getStoragePersona(String name)
StoragePersonaResponse	getStoragePersonaAssociatedWithStore(String name)
StoreResponse	getStore(String storeName)
StoreResponse	getStore(String storeName, int timeoutMs)
static StoreResponse	getStore(String urlsToFindLeaderController, String clusterName, String storeName)	Deprecated.
VersionResponse	getStoreLargestUsedVersion(String clusterName, String storeName)
SchemaResponse	getValueOrDerivedSchemaId(String storeName, String derivedSchemaStr)
SchemaResponse	getValueSchema(String storeName, int valueSchemaId)
SchemaResponse	getValueSchemaID(String storeName, String valueSchemaStr)
NodeStatusResponse	isNodeRemovable(String instanceId)
NodeStatusResponse	isNodeRemovable(String instanceId, List<String> lockedNodeIds)
StoreMigrationResponse	isStoreMigrationAllowed()
ReadyForDataRecoveryResponse	isStoreVersionReadyForDataRecovery(String sourceFabric, String destinationFabric, String storeName, int versionNumber, Optional<Integer> sourceAmplificationFactor)
ControllerResponse	killOfflinePushJob(String kafkaTopic)
MultiVersionStatusResponse	listBootstrappingVersions()
ChildAwareResponse	listChildControllers(String clusterName)
MultiNodesStatusResponse	listInstancesStatuses(boolean enableReplicas)
MultiReplicaResponse	listReplicas(String storeName, int version)
MultiReplicaResponse	listStorageNodeReplicas(String instanceId)
MultiNodeResponse	listStorageNodes()
StoreHealthAuditResponse	listStorePushInfo(String storeName, boolean isPartitionDetailEnabled)
MultiStoreStatusResponse	listStoresStatuses()
StoreMigrationResponse	migrateStore(String storeName, String destClusterName)
protected QueryParams	newParams()	Add all global parameters in this method.
NodeReplicasReadinessResponse	nodeReplicasReadiness(String instanceId)
VersionResponse	overrideSetActiveVersion(String storeName, int version)
ControllerResponse	prepareDataRecovery(String sourceFabric, String destinationFabric, String storeName, int versionNumber, Optional<Integer> sourceAmplificationFactor)
JobStatusQueryResponse	queryDetailedJobStatus(String kafkaTopic, String region)	This method will retrieve detailed job status, including uncompleted partitions and replicas from a child region.
JobStatusQueryResponse	queryJobStatus(String kafkaTopic)
JobStatusQueryResponse	queryJobStatus(String kafkaTopic, Optional<String> incrementalPushVersion)	This method is used to query the job status from a controller.
JobStatusQueryResponse	queryJobStatus(String kafkaTopic, Optional<String> incrementalPushVersion, int timeoutMs, String targetedRegions)
JobStatusQueryResponse	queryJobStatus(String kafkaTopic, Optional<String> incrementalPushVersion, String targetedRegions)
JobStatusQueryResponse	queryOverallJobStatus(String kafkaTopic, Optional<String> incrementalPushVersion)
JobStatusQueryResponse	queryOverallJobStatus(String kafkaTopic, Optional<String> incrementalPushVersion, String targetedRegions)	This method has a longer timeout intended to be used to query the overall job status on a parent controller.
MultiStoreResponse	queryStoreList()
MultiStoreResponse	queryStoreList(boolean includeSystemStores)
MultiStoreResponse	queryStoreList(boolean includeSystemStores, Optional<String> configNameFilter, Optional<String> configValueFilter)
SchemaResponse	removeDerivedSchema(String storeName, int valueSchemaId, int derivedSchemaId)
ControllerResponse	removeNodeFromAllowList(String instanceId)
ControllerResponse	removeNodeFromCluster(String instanceId)
ControllerResponse	removeStoreFromGraveyard(String storeName)
VersionCreationResponse	requestTopicForWrites(String storeName, long storeSize, Version.PushType pushType, String pushJobId, boolean sendStartOfPush, boolean sorted, boolean wcEnabled, Optional<String> partitioners, Optional<String> compressionDictionary, Optional<String> sourceGridFabric, boolean batchJobHeartbeatEnabled, long rewindTimeInSecondsOverride)
VersionCreationResponse	requestTopicForWrites(String storeName, long storeSize, Version.PushType pushType, String pushJobId, boolean sendStartOfPush, boolean sorted, boolean wcEnabled, Optional<String> partitioners, Optional<String> compressionDictionary, Optional<String> sourceGridFabric, boolean batchJobHeartbeatEnabled, long rewindTimeInSecondsOverride, boolean deferVersionSwap)
VersionCreationResponse	requestTopicForWrites(String storeName, long storeSize, Version.PushType pushType, String pushJobId, boolean sendStartOfPush, boolean sorted, boolean wcEnabled, Optional<String> partitioners, Optional<String> compressionDictionary, Optional<String> sourceGridFabric, boolean batchJobHeartbeatEnabled, long rewindTimeInSecondsOverride, boolean deferVersionSwap, String targetedRegions, int repushSourceVersion, boolean pushToSeparateRealtimeTopic)	Request a topic for the VeniceWriter to write into.
<R extends ControllerResponse> R	retryableRequest(int totalAttempts, Function<ControllerClient,R> request)
<R extends ControllerResponse> R	retryableRequest(int totalAttempts, Function<ControllerClient,R> request, Function<R,Boolean> abortRetryCondition)
static <C extends ControllerClient, R extends ControllerResponse> R	retryableRequest(C client, int totalAttempts, Function<C,R> request)	Useful for pieces of code which want to have a test mocking the result of the function that's passed in...
static <C extends ControllerClient, R extends ControllerResponse> R	retryableRequest(C client, int totalAttempts, Function<C,R> request, Function<R,Boolean> abortRetryCondition)
ControllerResponse	rollbackToBackupVersion(String storeName)
ControllerResponse	rollbackToBackupVersion(String storeName, String regionFilter)
ControllerResponse	rollForwardToFutureVersion(String storeName)
ControllerResponse	rollForwardToFutureVersion(String storeName, String regionFilter)
ControllerResponse	sendEmptyPushAndWait(String storeName, String pushJobId, long storeSize, long timeOut)	Sends and empty push to the venice controller, but verifies that the push has succeeded before returning to the caller.
ControllerResponse	sendHeartbeatToSystemStore(String storeName, long heartbeatTimestamp)
ControllerResponse	sendPushJobDetails(String storeName, int version, byte[] pushJobDetails)
ControllerResponse	setMigrationPushStrategy(String voldemortStoreName, String pushStrategy)
OwnerResponse	setStoreOwner(String storeName, String owner)
PartitionResponse	setStorePartitionCount(String storeName, String partitionNum)
ControllerResponse	skipAdminMessage(String offset, boolean skipDIV)
AclResponse	updateAclForStore(String storeName, String accessPermissions)
ControllerResponse	updateAdminTopicMetadata(long executionId, Optional<String> storeName, Optional<Long> offset, Optional<Long> upstreamOffset)
ControllerResponse	updateClusterConfig(UpdateClusterConfigQueryParams queryParams)
ControllerResponse	updateKafkaTopicLogCompaction(String kafkaTopicName, boolean logCompactionEnabled)
ControllerResponse	updateKafkaTopicMinInSyncReplica(String kafkaTopicName, int minISR)
ControllerResponse	updateKafkaTopicRetention(String kafkaTopicName, long retentionInMs)
ControllerResponse	updateStoragePersona(String name, UpdateStoragePersonaQueryParams queryParams)
ControllerResponse	updateStore(String storeName, UpdateStoreQueryParams queryParams)
ControllerResponse	wipeCluster(String fabric, Optional<String> storeName, Optional<Integer> versionNum)
ControllerResponse	writeEndOfPush(String storeName, int version)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ControllerClient

public ControllerClient(String clusterName,
 String discoveryUrls)

ControllerClient

public ControllerClient(String clusterName,
 String discoveryUrls,
 Optional<SSLFactory> sslFactory)

Parameters:

discoveryUrls - comma-delimited urls to find leader controller.

Method Details

discoverAndConstructControllerClient

@Deprecated
public static ControllerClient discoverAndConstructControllerClient(String storeName,
 String discoveryUrls,
 Optional<SSLFactory> sslFactory,
 int retryAttempts)

Deprecated.

Use ControllerClientFactory.discoverAndConstructControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>, int)

constructClusterControllerClient

@Deprecated
public static ControllerClient constructClusterControllerClient(String clusterName,
 String discoveryUrls)

Deprecated.

Use ControllerClientFactory.getControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>)

constructClusterControllerClient

@Deprecated
public static ControllerClient constructClusterControllerClient(String clusterName,
 String discoveryUrls,
 Optional<SSLFactory> sslFactory)

Deprecated.

Use ControllerClientFactory.getControllerClient(java.lang.String, java.lang.String, java.util.Optional<com.linkedin.venice.security.SSLFactory>)

close

public void close()

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

discoverLeaderController

protected String discoverLeaderController()

getStore

public StoreResponse getStore(String storeName)

getStore

public StoreResponse getStore(String storeName,
 int timeoutMs)

getRepushInfo

public RepushInfoResponse getRepushInfo(String storeName,
 Optional<String> fabricName)

getFutureVersions

public MultiStoreStatusResponse getFutureVersions(String clusterName,
 String storeName)

getBackupVersions

public MultiStoreStatusResponse getBackupVersions(String clusterName,
 String storeName)

getStore

@Deprecated
public static StoreResponse getStore(String urlsToFindLeaderController,
 String clusterName,
 String storeName)

Deprecated.

getStorageEngineOverheadRatio

public StorageEngineOverheadRatioResponse getStorageEngineOverheadRatio(String storeName)

getInUseSchemaIds

public SchemaUsageResponse getInUseSchemaIds(String storeName)

deleteValueSchemas

public ControllerResponse deleteValueSchemas(String storeName,
 List<String> schemaIds)

requestTopicForWrites

public VersionCreationResponse requestTopicForWrites(String storeName,
 long storeSize,
 Version.PushType pushType,
 String pushJobId,
 boolean sendStartOfPush,
 boolean sorted,
 boolean wcEnabled,
 Optional<String> partitioners,
 Optional<String> compressionDictionary,
 Optional<String> sourceGridFabric,
 boolean batchJobHeartbeatEnabled,
 long rewindTimeInSecondsOverride)

requestTopicForWrites

public VersionCreationResponse requestTopicForWrites(String storeName,
 long storeSize,
 Version.PushType pushType,
 String pushJobId,
 boolean sendStartOfPush,
 boolean sorted,
 boolean wcEnabled,
 Optional<String> partitioners,
 Optional<String> compressionDictionary,
 Optional<String> sourceGridFabric,
 boolean batchJobHeartbeatEnabled,
 long rewindTimeInSecondsOverride,
 boolean deferVersionSwap)

requestTopicForWrites

public VersionCreationResponse requestTopicForWrites(String storeName,
 long storeSize,
 Version.PushType pushType,
 String pushJobId,
 boolean sendStartOfPush,
 boolean sorted,
 boolean wcEnabled,
 Optional<String> partitioners,
 Optional<String> compressionDictionary,
 Optional<String> sourceGridFabric,
 boolean batchJobHeartbeatEnabled,
 long rewindTimeInSecondsOverride,
 boolean deferVersionSwap,
 String targetedRegions,
 int repushSourceVersion,
 boolean pushToSeparateRealtimeTopic)

Request a topic for the VeniceWriter to write into. A new VPJ push, or a Samza bulk processing job should both use this method. The push job ID needs to be unique for this push. Multiple requests with the same pushJobId are idempotent and will return the same topic.

Parameters:

storeName - Name of the store being written to.

storeSize - Estimated size of push in bytes, used to determine partitioning

pushJobId - Unique identifier for this job

sendStartOfPush - Whether controller should send START_OF_PUSH message to the newly created topic, while adding a new version. This is currently used in Samza batch load, a.k.a. grandfather

sorted - Whether the push is going to contain sorted data (in each partition) or not

wcEnabled - Whether write compute is enabled for this push job or not

partitioners - partitioner class names in a string seperated by comma

compressionDictionary - Base64 encoded dictionary to be used to perform dictionary compression

sourceGridFabric - An identifier of the data center which is used in native replication to determine the Kafka URL

batchJobHeartbeatEnabled - whether batch push job enables the heartbeat

rewindTimeInSecondsOverride - if a valid value is specified (>=0) for hybrid store, this param will override the default store-level rewindTimeInSeconds config.

deferVersionSwap - whether to defer version swap after the push is done

targetedRegions - the list of regions that is separated by comma for targeted region push.

repushSourceVersion -

Returns:

VersionCreationResponse includes topic and partitioning

addVersionAndStartIngestion

public VersionResponse addVersionAndStartIngestion(String storeName,
 String pushJobId,
 int version,
 int partitionCount,
 Version.PushType pushType,
 String remoteKafkaBootstrapServers,
 long rewindTimeInSecondsOverride,
 int replicationMetadataVersionId)

Used for store migration to add version and start ingestion in destination cluster for new pushes in the source cluster during the ingestion. The idea is like copying or create a version on an existing topic. Different use cases can be explored and expanded in the future. Applicable only to child controllers.

Parameters:

storeName - of the original push.

pushJobId - of the original push.

version - of the original push.

partitionCount - of the original push.

pushType - of the producer.

remoteKafkaBootstrapServers - of the original push.

rewindTimeInSecondsOverride - of the original push.

replicationMetadataVersionId - of the original push.

Returns:

writeEndOfPush

public ControllerResponse writeEndOfPush(String storeName,
 int version)

sendEmptyPushAndWait

public ControllerResponse sendEmptyPushAndWait(String storeName,
 String pushJobId,
 long storeSize,
 long timeOut)

Sends and empty push to the venice controller, but verifies that the push has succeeded before returning to the caller.

Parameters:

storeName - the store name for which the empty push is for

pushJobId - the push job id for the push

storeSize - the size of the store (currently unused)

timeOut - max amount of time this function should take before returning in MILLISECONDS. Retries sent to the controller have 2-second sleeps between them. So a timeout should be chosen that is larger, and a multiple of 2 seconds preferably.

Returns:

the response from the controller. Either a successful one, or a failed one with more information.

createNewStoreWithParameters

public ControllerResponse createNewStoreWithParameters(String storeName,
 String owner,
 String keySchema,
 String valueSchema,
 UpdateStoreQueryParams updateStoreQueryParams)

Simplified API that wraps together the store create and update functionalities with some clean up functionality

Parameters:

storeName - the store name to create and update

owner - the owner of this store to be created

keySchema - Schema of the key for row retrieval for this store

valueSchema - Schema of the value for rows in this new store

updateStoreQueryParams - What parameters should be applied to this store after it's creation

Returns:

The response from the first failed operation of store creation or modification

emptyPush

public VersionCreationResponse emptyPush(String storeName,
 String pushJobId,
 long storeSize)

createNewStore

public NewStoreResponse createNewStore(String storeName,
 String owner,
 String keySchema,
 String valueSchema)

createNewStore

public NewStoreResponse createNewStore(String storeName,
 String owner,
 String keySchema,
 String valueSchema,
 String accessPermissions)

createNewSystemStore

public NewStoreResponse createNewSystemStore(String storeName,
 String owner,
 String keySchema,
 String valueSchema)

isStoreMigrationAllowed

public StoreMigrationResponse isStoreMigrationAllowed()

migrateStore

public StoreMigrationResponse migrateStore(String storeName,
 String destClusterName)

completeMigration

public StoreMigrationResponse completeMigration(String storeName,
 String destClusterName)

abortMigration

public StoreMigrationResponse abortMigration(String storeName,
 String destClusterName)

This command should be sent to src controller, not dest controller

deleteStore

public TrackableControllerResponse deleteStore(String storeName)

wipeCluster

public ControllerResponse wipeCluster(String fabric,
 Optional<String> storeName,
 Optional<Integer> versionNum)

compareStore

public StoreComparisonResponse compareStore(String storeName,
 String fabricA,
 String fabricB)

copyOverStoreMetadata

public StoreResponse copyOverStoreMetadata(String sourceFabric,
 String destFabric,
 String storeName)

disableAndDeleteStore

public ControllerResponse disableAndDeleteStore(String storeName)

overrideSetActiveVersion

public VersionResponse overrideSetActiveVersion(String storeName,
 int version)

rollbackToBackupVersion

public ControllerResponse rollbackToBackupVersion(String storeName,
 String regionFilter)

rollbackToBackupVersion

public ControllerResponse rollbackToBackupVersion(String storeName)

rollForwardToFutureVersion

public ControllerResponse rollForwardToFutureVersion(String storeName,
 String regionFilter)

rollForwardToFutureVersion

public ControllerResponse rollForwardToFutureVersion(String storeName)

killOfflinePushJob

public ControllerResponse killOfflinePushJob(String kafkaTopic)

skipAdminMessage

public ControllerResponse skipAdminMessage(String offset,
 boolean skipDIV)

getKafkaTopicConfigs

public PubSubTopicConfigResponse getKafkaTopicConfigs(String kafkaTopicName)

updateKafkaTopicLogCompaction

public ControllerResponse updateKafkaTopicLogCompaction(String kafkaTopicName,
 boolean logCompactionEnabled)

updateKafkaTopicRetention

public ControllerResponse updateKafkaTopicRetention(String kafkaTopicName,
 long retentionInMs)

updateKafkaTopicMinInSyncReplica

public ControllerResponse updateKafkaTopicMinInSyncReplica(String kafkaTopicName,
 int minISR)

retryableRequest

public <R extends ControllerResponse> R retryableRequest(int totalAttempts,
 Function<ControllerClient,R> request)

retryableRequest

public <R extends ControllerResponse> R retryableRequest(int totalAttempts,
 Function<ControllerClient,R> request,
 Function<R,Boolean> abortRetryCondition)

retryableRequest

public static <C extends ControllerClient,
R extends ControllerResponse>
R retryableRequest(C client,
 int totalAttempts,
 Function<C,R> request)

Useful for pieces of code which want to have a test mocking the result of the function that's passed in...

retryableRequest

public static <C extends ControllerClient,
R extends ControllerResponse>
R retryableRequest(C client,
 int totalAttempts,
 Function<C,R> request,
 Function<R,Boolean> abortRetryCondition)

queryOverallJobStatus

public JobStatusQueryResponse queryOverallJobStatus(String kafkaTopic,
 Optional<String> incrementalPushVersion,
 String targetedRegions)

This method has a longer timeout intended to be used to query the overall job status on a parent controller. The extended timeout is meant for the parent controller to query each colo's child controller for the job status and aggregate the results. Use queryJobStatus(String, Optional) instead if the target is a child controller.

Parameters:

kafkaTopic - , the version topic name of the push job.

incrementalPushVersion - , the optional incremental push version of the push job.

targetedRegions - , the list of regions that is separated by comma for targeted region push.

Returns:

queryOverallJobStatus

public JobStatusQueryResponse queryOverallJobStatus(String kafkaTopic,
 Optional<String> incrementalPushVersion)

queryJobStatus

public JobStatusQueryResponse queryJobStatus(String kafkaTopic)

queryJobStatus

public JobStatusQueryResponse queryJobStatus(String kafkaTopic,
 Optional<String> incrementalPushVersion)

This method is used to query the job status from a controller. It is expected to be a child controller thus a shorter timeout is enforced. Use queryOverallJobStatus(String, Optional) instead if the target is a parent controller.

queryJobStatus

public JobStatusQueryResponse queryJobStatus(String kafkaTopic,
 Optional<String> incrementalPushVersion,
 String targetedRegions)

queryJobStatus

public JobStatusQueryResponse queryJobStatus(String kafkaTopic,
 Optional<String> incrementalPushVersion,
 int timeoutMs,
 String targetedRegions)

queryDetailedJobStatus

public JobStatusQueryResponse queryDetailedJobStatus(String kafkaTopic,
 String region)

This method will retrieve detailed job status, including uncompleted partitions and replicas from a child region. If the request is sent to a parent controller, it will be forwarded to a child controller in the specified region. This method is used for data recovery progress monitoring.

sendPushJobDetails

public ControllerResponse sendPushJobDetails(String storeName,
 int version,
 byte[] pushJobDetails)

queryStoreList

public MultiStoreResponse queryStoreList()

queryStoreList

public MultiStoreResponse queryStoreList(boolean includeSystemStores)

queryStoreList

public MultiStoreResponse queryStoreList(boolean includeSystemStores,
 Optional<String> configNameFilter,
 Optional<String> configValueFilter)

listStoresStatuses

public MultiStoreStatusResponse listStoresStatuses()

enableStoreWrites

public ControllerResponse enableStoreWrites(String storeName,
 boolean enable)

enableStoreReads

public ControllerResponse enableStoreReads(String storeName,
 boolean enable)

enableStoreReadWrites

public ControllerResponse enableStoreReadWrites(String storeName,
 boolean enable)

deleteAllVersions

public MultiVersionResponse deleteAllVersions(String storeName)

deleteOldVersion

public VersionResponse deleteOldVersion(String storeName,
 int versionNum)

isNodeRemovable

public NodeStatusResponse isNodeRemovable(String instanceId)

isNodeRemovable

public NodeStatusResponse isNodeRemovable(String instanceId,
 List<String> lockedNodeIds)

addNodeIntoAllowList

public ControllerResponse addNodeIntoAllowList(String instanceId)

removeNodeFromAllowList

public ControllerResponse removeNodeFromAllowList(String instanceId)

removeNodeFromCluster

public ControllerResponse removeNodeFromCluster(String instanceId)

listStorageNodes

public MultiNodeResponse listStorageNodes()

getAggregatedHealthStatus

public StoppableNodeStatusResponse getAggregatedHealthStatus(String clusterName,
 List<String> instances,
 List<String> toBeStoppedInstances)
                                                      throws com.fasterxml.jackson.core.JsonProcessingException

Throws:

com.fasterxml.jackson.core.JsonProcessingException

listInstancesStatuses

public MultiNodesStatusResponse listInstancesStatuses(boolean enableReplicas)

listReplicas

public MultiReplicaResponse listReplicas(String storeName,
 int version)

listStorageNodeReplicas

public MultiReplicaResponse listStorageNodeReplicas(String instanceId)

nodeReplicasReadiness

public NodeReplicasReadinessResponse nodeReplicasReadiness(String instanceId)

listChildControllers

public ChildAwareResponse listChildControllers(String clusterName)

getKeySchema

public SchemaResponse getKeySchema(String storeName)

addValueSchema

public SchemaResponse addValueSchema(String storeName,
 String valueSchemaStr)

addValueSchema

public SchemaResponse addValueSchema(String storeName,
 String valueSchemaStr,
 int valueSchemaId)

addValueSchema

public SchemaResponse addValueSchema(String storeName,
 String valueSchemaStr,
 int valueSchemaId,
 DirectionalSchemaCompatibilityType schemaCompatType)

addDerivedSchema

public SchemaResponse addDerivedSchema(String storeName,
 int valueSchemaId,
 String derivedSchemaStr)

addDerivedSchema

public SchemaResponse addDerivedSchema(String storeName,
 int valueSchemaId,
 String derivedSchemaStr,
 int derivedSchemaId)

removeDerivedSchema

public SchemaResponse removeDerivedSchema(String storeName,
 int valueSchemaId,
 int derivedSchemaId)

setStorePartitionCount

public PartitionResponse setStorePartitionCount(String storeName,
 String partitionNum)

setStoreOwner

public OwnerResponse setStoreOwner(String storeName,
 String owner)

updateStore

public ControllerResponse updateStore(String storeName,
 UpdateStoreQueryParams queryParams)

getValueSchema

public SchemaResponse getValueSchema(String storeName,
 int valueSchemaId)

getValueSchemaID

public SchemaResponse getValueSchemaID(String storeName,
 String valueSchemaStr)

getValueOrDerivedSchemaId

public SchemaResponse getValueOrDerivedSchemaId(String storeName,
 String derivedSchemaStr)

getAllValueSchema

public MultiSchemaResponse getAllValueSchema(String storeName)

getAllReplicationMetadataSchemas

public MultiSchemaResponse getAllReplicationMetadataSchemas(String storeName)

getAllValueAndDerivedSchema

public MultiSchemaResponse getAllValueAndDerivedSchema(String storeName)

getAdminCommandExecution

public AdminCommandExecutionResponse getAdminCommandExecution(long executionId)

getLastSucceedExecutionId

public LastSucceedExecutionIdResponse getLastSucceedExecutionId()

enableThrottling

public ControllerResponse enableThrottling(boolean isThrottlingEnabled)

enableMaxCapacityProtection

public ControllerResponse enableMaxCapacityProtection(boolean isMaxCapacityProtection)

enableQuotaRebalanced

public ControllerResponse enableQuotaRebalanced(boolean isQuotaRebalanced,
 int expectRouterCount)

getRoutersClusterConfig

public RoutersClusterConfigResponse getRoutersClusterConfig()

getMigrationPushStrategies

public MigrationPushStrategyResponse getMigrationPushStrategies()

setMigrationPushStrategy

public ControllerResponse setMigrationPushStrategy(String voldemortStoreName,
 String pushStrategy)

listBootstrappingVersions

public MultiVersionStatusResponse listBootstrappingVersions()

updateAclForStore

public AclResponse updateAclForStore(String storeName,
 String accessPermissions)

getAclForStore

public AclResponse getAclForStore(String storeName)

deleteAclForStore

public AclResponse deleteAclForStore(String storeName)

sendHeartbeatToSystemStore

public ControllerResponse sendHeartbeatToSystemStore(String storeName,
 long heartbeatTimestamp)

getHeartbeatFromSystemStore

public SystemStoreHeartbeatResponse getHeartbeatFromSystemStore(String storeName)

configureActiveActiveReplicationForCluster

public ControllerResponse configureActiveActiveReplicationForCluster(boolean enableActiveActiveReplication,
 String storeType,
 Optional<String> regionsFilter)

checkResourceCleanupForStoreCreation

public ControllerResponse checkResourceCleanupForStoreCreation(String storeName)

getQueryParamsToDiscoverCluster

protected static QueryParams getQueryParamsToDiscoverCluster(String storeName)

getDeletableStoreTopics

public MultiStoreTopicsResponse getDeletableStoreTopics()

getClusterStaleStores

public ClusterStaleDataAuditResponse getClusterStaleStores(String clusterName,
 String parentControllerUrl)

getClusterStores

public MultiStoreInfoResponse getClusterStores(String clusterName)

getStoreLargestUsedVersion

public VersionResponse getStoreLargestUsedVersion(String clusterName,
 String storeName)

getRegionPushDetails

public RegionPushDetailsResponse getRegionPushDetails(String storeName,
 boolean isPartitionDetailEnabled)

listStorePushInfo

public StoreHealthAuditResponse listStorePushInfo(String storeName,
 boolean isPartitionDetailEnabled)

discoverCluster

public static D2ServiceDiscoveryResponse discoverCluster(String discoveryUrls,
 String storeName,
 Optional<SSLFactory> sslFactory,
 int retryAttempts)

discoverCluster

public D2ServiceDiscoveryResponse discoverCluster(String storeName)

updateClusterConfig

public ControllerResponse updateClusterConfig(UpdateClusterConfigQueryParams queryParams)

prepareDataRecovery

public ControllerResponse prepareDataRecovery(String sourceFabric,
 String destinationFabric,
 String storeName,
 int versionNumber,
 Optional<Integer> sourceAmplificationFactor)

isStoreVersionReadyForDataRecovery

public ReadyForDataRecoveryResponse isStoreVersionReadyForDataRecovery(String sourceFabric,
 String destinationFabric,
 String storeName,
 int versionNumber,
 Optional<Integer> sourceAmplificationFactor)

dataRecovery

public ControllerResponse dataRecovery(String sourceFabric,
 String destinationFabric,
 String storeName,
 int versionNumber,
 boolean sourceVersionIncluded,
 boolean copyAllVersionConfigs,
 Optional<Version> sourceVersion)

getAdminTopicMetadata

public AdminTopicMetadataResponse getAdminTopicMetadata(Optional<String> storeName)

updateAdminTopicMetadata

public ControllerResponse updateAdminTopicMetadata(long executionId,
 Optional<String> storeName,
 Optional<Long> offset,
 Optional<Long> upstreamOffset)

deleteKafkaTopic

public ControllerResponse deleteKafkaTopic(String topicName)

createStoragePersona

public ControllerResponse createStoragePersona(String name,
 long quota,
 Set<String> storesToEnforce,
 Set<String> owners)

getStoragePersona

public StoragePersonaResponse getStoragePersona(String name)

deleteStoragePersona

public ControllerResponse deleteStoragePersona(String name)

updateStoragePersona

public ControllerResponse updateStoragePersona(String name,
 UpdateStoragePersonaQueryParams queryParams)

getStoragePersonaAssociatedWithStore

public StoragePersonaResponse getStoragePersonaAssociatedWithStore(String name)

getClusterStoragePersonas

public MultiStoragePersonaResponse getClusterStoragePersonas()

cleanupInstanceCustomizedStates

public MultiStoreTopicsResponse cleanupInstanceCustomizedStates()

removeStoreFromGraveyard

public ControllerResponse removeStoreFromGraveyard(String storeName)

newParams

protected QueryParams newParams()

Add all global parameters in this method. Always use a form of this method to generate a new list of NameValuePair objects for making HTTP requests.

Returns:

encodeQueryParams

protected static String encodeQueryParams(QueryParams params)

getClusterName

public String getClusterName()

getLeaderControllerUrl

public String getLeaderControllerUrl()

getControllerDiscoveryUrls

public Collection<String> getControllerDiscoveryUrls()