org.apache.flink.runtime.jobmaster

Interface KvStateRegistryGateway

All Known Subinterfaces:

JobMasterGateway

All Known Implementing Classes:

JobMaster

public interface KvStateRegistryGateway

Gateway to report key-value state registration and deregistrations.

Method Summary

Modifier and Type	Method and Description
CompletableFuture<Acknowledge>	notifyKvStateRegistered(JobID jobId, JobVertexID jobVertexId, KeyGroupRange keyGroupRange, String registrationName, KvStateID kvStateId, InetSocketAddress kvStateServerAddress) Notifies that queryable state has been registered.
CompletableFuture<Acknowledge>	notifyKvStateUnregistered(JobID jobId, JobVertexID jobVertexId, KeyGroupRange keyGroupRange, String registrationName) Notifies that queryable state has been unregistered.

Method Detail

notifyKvStateRegistered

CompletableFuture<Acknowledge> notifyKvStateRegistered(JobID jobId,
                                                       JobVertexID jobVertexId,
                                                       KeyGroupRange keyGroupRange,
                                                       String registrationName,
                                                       KvStateID kvStateId,
                                                       InetSocketAddress kvStateServerAddress)

Notifies that queryable state has been registered.

Parameters:

jobId - identifying the job for which to register a key value state

jobVertexId - JobVertexID the KvState instance belongs to.

keyGroupRange - Key group range the KvState instance belongs to.

registrationName - Name under which the KvState has been registered.

kvStateId - ID of the registered KvState instance.

kvStateServerAddress - Server address where to find the KvState instance.

Returns:

Future acknowledge if the key-value state has been registered

notifyKvStateUnregistered

CompletableFuture<Acknowledge> notifyKvStateUnregistered(JobID jobId,
                                                         JobVertexID jobVertexId,
                                                         KeyGroupRange keyGroupRange,
                                                         String registrationName)

Notifies that queryable state has been unregistered.

Parameters:

jobId - identifying the job for which to unregister a key value state

jobVertexId - JobVertexID the KvState instance belongs to.

keyGroupRange - Key group index the KvState instance belongs to.

registrationName - Name under which the KvState has been registered.

Returns:

Future acknowledge if the key-value state has been unregistered