Package com.linkedin.venice.hooks

Class GrpcStoreLifecycleHooks

java.lang.Object

com.linkedin.venice.hooks.StoreLifecycleHooks

com.linkedin.venice.hooks.GrpcStoreLifecycleHooks

All Implemented Interfaces:

Closeable, AutoCloseable

public class GrpcStoreLifecycleHooks
extends StoreLifecycleHooks
implements Closeable

A hook implementation that calls a gRPC service for store lifecycle events. Uses static caching to maintain state across multiple instances created through reflection.

Constructor Summary

Constructors

Constructor	Description
GrpcStoreLifecycleHooks(VeniceProperties defaultConfigs)

Method Summary

Modifier and Type	Method	Description
void	close()
StoreVersionLifecycleEventOutcome	postStoreVersionSwap(String clusterName, String storeName, int versionNumber, String regionName, Lazy<JobStatusQueryResponse> jobStatus, VeniceProperties storeHooksConfigs)	Invoked after swapping read traffic for servers. Cardinality: once per store-version per region which has successfully swapped.
StoreLifecycleEventOutcome	validateHookParams(String clusterName, String storeName, Map<String,String> hookParams)	Invoked prior to updating a store's config with a given list of params.

Methods inherited from class com.linkedin.venice.hooks.StoreLifecycleHooks

getDefaultConfigs, postEndOfPushJob, postSchemaRegistration, postStartOfPushJob, postStartOfStoreVersionIngestionForDaVinci, postStoreVersionCreation, postStoreVersionLeaderReplication, preEndOfPushJob, preSchemaRegistration, preStartOfPushJob, preStartOfStoreVersionIngestionForDaVinci, preStoreVersionCreation, preStoreVersionSwap, validateHookConfig

Methods inherited from class java.lang.Object

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

Constructor Details

GrpcStoreLifecycleHooks

public GrpcStoreLifecycleHooks(VeniceProperties defaultConfigs)

Method Details

validateHookParams

public StoreLifecycleEventOutcome validateHookParams(String clusterName,
 String storeName,
 Map<String,String> hookParams)

Description copied from class: StoreLifecycleHooks

Invoked prior to updating a store's config with a given list of params. If the hook implementation recognizes the params, then it will return StoreLifecycleEventOutcome.PROCEED, otherwise it should return * StoreLifecycleEventOutcome.ABORT if any params are missing or invalid.

Overrides:

validateHookParams in class StoreLifecycleHooks

Returns:

postStoreVersionSwap

public StoreVersionLifecycleEventOutcome postStoreVersionSwap(String clusterName,
 String storeName,
 int versionNumber,
 String regionName,
 Lazy<JobStatusQueryResponse> jobStatus,
 VeniceProperties storeHooksConfigs)

Description copied from class: StoreLifecycleHooks

Invoked after swapping read traffic for servers.

Cardinality: once per store-version per region which has successfully swapped.

Overrides:

postStoreVersionSwap in class StoreLifecycleHooks

close

public void close()
           throws IOException

Specified by:

close in interface AutoCloseable

Specified by:

close in interface Closeable

Throws:

IOException