All Classes
-
All Classes Interface Summary Class Summary Enum Summary Exception Summary Error Summary Class Description AbstractContainerizedClusterClientFactory<ClusterID> An abstractClusterClientFactorycontaining some common implementations for different containerized deployment clusters.AbstractCustomCommandLine Base class forCustomCommandLineimplementations which specify a JobManager address and a ZooKeeper namespace.AbstractJobClusterExecutor<ClusterID,ClientFactory extends ClusterClientFactory<ClusterID>> Deprecated. AbstractSessionClusterExecutor<ClusterID,ClientFactory extends ClusterClientFactory<ClusterID>> An abstractPipelineExecutorused to executepipelineson an existing (session) cluster.ApplicationClusterDeployer An entity responsible for submitting an application for execution in "Application Mode", i.e.ApplicationClusterEntryPoint Base class for cluster entry points targeting executing applications in "Application Mode".ApplicationConfiguration Application-specific configurations.ApplicationDeployer An interface to be used by theCliFrontendto submit user programs for execution.ApplicationDispatcherBootstrap ADispatcherBootstrapused for running the user'smain()in "Application Mode" (see FLIP-85).ApplicationDispatcherGatewayServiceFactory ADispatcherGatewayServiceFactoryused when executing a job in Application Mode, i.e.ApplicationDispatcherLeaderProcessFactoryFactory Factory for aDispatcherLeaderProcessFactoryFactorydesigned to be used when executing an application in Application Mode.ApplicationExecutionException AFlinkExceptionthrown in case something during application execution went wrong.ApplicationRunner An interface to be implemented by the entities responsible for application submission for the different deployment environments.CancelOptions Command line options for the CANCEL command.CliArgsException Special exception that is thrown when the command line parsing fails.ClientOptions Describes a client configuration parameter.ClientUtils Utility functions for Flink client.CliFrontend Implementation of a simple command line frontend for executing programs.CliFrontendParser A simple command line parser (based on Apache Commons CLI) that extracts command line options.ClusterClient<T> Encapsulates the functionality necessary to submit a program to a remote cluster.ClusterClientFactory<ClusterID> A factory containing all the necessary information for creating clients to Flink clusters.ClusterClientJobClientAdapter<ClusterID> An implementation of theJobClientinterface that uses aClusterClientunderneath..ClusterClientProvider<T> Factory forClusterClients.ClusterClientServiceLoader An interface used to discover the appropriatecluster client factorybased on the providedConfiguration.ClusterDeploymentException Class which indicates a problem when deploying a Flink cluster.ClusterDescriptor<T> A descriptor to deploy a cluster (e.g.ClusterRetrieveException Exception which indicates that a cluster could not be retrieved.ClusterSpecification Description of the cluster to start by theClusterDescriptor.ClusterSpecification.ClusterSpecificationBuilder Builder for theClusterSpecificationinstance.CommandLineOptions Base class for all options parsed from the command line.ContextEnvironment Execution Environment for remote execution with the Client.CustomCommandLine Custom command-line interface to load hooks for the command-line interface.DefaultCLI The default CLI which is used for interaction with standalone clusters.DefaultClusterClientServiceLoader A service provider forcluster client factories.DefaultPackagedProgramRetriever PackageProgramRetrieverImplis the default implementation ofPackagedProgramRetrieverthat can either retrieve aPackagedProgramfrom a specific jar, some provided user classpath or the system classpath.DetachedApplicationRunner AnApplicationRunnerwhich runs the user specified application using theEmbeddedExecutor.DynamicPropertiesUtil Helper class for supporting dynamic property commandline options inCustomCommandLines.EmbeddedExecutor A base class forexecutorsthat invoke directly methods of theDispatcherand do not go through the REST API.EmbeddedExecutorFactory AnPipelineExecutorFactoryfor theEmbeddedExecutor.EmbeddedExecutorServiceLoader APipelineExecutorServiceLoaderthat always returns anEmbeddedExecutorFactory.EmbeddedJobClient AJobClientwith the ability to also submit jobs which uses directly theDispatcherGateway.EmbeddedJobClientCreator An interface to be implemented byJobClientsuppliers.EntryClassInformationProvider EntryClassInformationProviderprovides information about the entry class.ExecutionConfigAccessor Accessor that exposes config settings that are relevant for execution from an underlyingConfiguration.ExponentialWaitStrategy WaitStrategywith exponentially increasing sleep time.FlinkPipelineTranslationUtil Utility for transformingFlinkPipelinesinto aJobGraph.FlinkPipelineTranslator This can be used to turn aPipelineinto aJobGraph.FromClasspathEntryClassInformationProvider FromClasspathEntryClassInformationProviderassumes the passed job class being available on some classpath.FromJarEntryClassInformationProvider FromJarEntryClassInformationProvideris used for cases where the Jar archive is explicitly specified.GenericCLI A generic implementation of theCustomCommandLinethat only expects the execution.target parameter to be explicitly specified and simply forwards the rest of the options specified with -D to the correspondingPipelineExecutorfor further parsing.JarManifestParser Utility that parses JAR manifest attributes.ListOptions Command line options for the LIST command.LocalExecutor AnPipelineExecutorfor executing aPipelinelocally.LocalExecutorFactory AnPipelineExecutorFactoryforlocal executors.MiniClusterClient Client to interact with aMiniCluster.MiniClusterClient.MiniClusterId The type of the Cluster ID for the localMiniCluster.MutatedConfigurationException IfDeploymentOptions.PROGRAM_CONFIG_ENABLEDis disabled, configurations in the user jar will throw this exception.OptimizerPlanEnvironment AnExecutionEnvironmentthat never executes a job but only extracts thePipeline.PackagedProgram This class encapsulates represents a program, packaged in a jar file.PackagedProgram.Builder A Builder ForPackagedProgram.PackagedProgramRetriever Interface which allows to retrieve thePackagedProgram.PackagedProgramUtils Utility class forPackagedProgramrelated operations.PerJobMiniClusterFactory Starts aMiniClusterfor every submitted job.PipelineExecutorUtils Utility class with method related to job execution.PlanTranslator FlinkPipelineTranslatorfor DataSet APIPlans.ProgramAbortException A special exception used to abort programs when the caller is only interested in the program plan, rather than in the full execution.ProgramInvocationException Exception used to indicate that there is an error during the invocation of a Flink program.ProgramMissingJobException Exception used to indicate that no job was executed during the invocation of a Flink program.ProgramOptions Base class for command line options that refer to a JAR file program.ProgramOptionsUtils Utility class forProgramOptions.ProgramParametrizationException Exception used to indicate that there is an error in the parametrization of a Flink program.RemoteExecutor ThePipelineExecutorto be used when executing a job on an already running cluster.RemoteExecutorFactory AnPipelineExecutorFactoryforremote executors.RestClusterClient<T> AClusterClientimplementation that communicates via HTTP REST requests.RestClusterClientConfiguration A configuration object forRestClusterClients.SavepointOptions Command line options for the SAVEPOINT command.StandaloneClientFactory AClusterClientFactoryfor a standalone cluster, i.e.StandaloneClusterDescriptor A deployment descriptor for an existing cluster.StandaloneClusterId Identifier for standalone clusters.StreamContextEnvironment SpecialStreamExecutionEnvironmentthat will be used in cases where the CLI client or testing utilities create aStreamExecutionEnvironmentthat should be used whenStreamExecutionEnvironment.getExecutionEnvironment()is called.StreamGraphTranslator FlinkPipelineTranslatorfor DataStream APIStreamGraphs.StreamPlanEnvironment A specialStreamExecutionEnvironmentthat is used in the web frontend when generating a user-inspectable graph of a streaming job.UnsuccessfulExecutionException Exception that signals the failure of an application with a givenApplicationStatus.WaitStrategy Operations that are polling for a result to arrive require a waiting time between consecutive polls.WebSubmissionExecutorFactory WebSubmissionExecutorServiceLoader APipelineExecutorServiceLoaderthat always returns anWebSubmissionExecutorFactory.WebSubmissionJobClient AJobClientthat only allows asking for the job id of the job it is attached to.