Index (Flink : Clients 1.18.0 API)

A B C D E F G H I J K L M N O P R S T U V W Y Z

A

AbstractContainerizedClusterClientFactory<ClusterID> - Class in org.apache.flink.client.deployment: An abstract ClusterClientFactory containing some common implementations for different containerized deployment clusters.
AbstractContainerizedClusterClientFactory() - Constructor for class org.apache.flink.client.deployment.AbstractContainerizedClusterClientFactory
AbstractCustomCommandLine - Class in org.apache.flink.client.cli: Base class for CustomCommandLine implementations which specify a JobManager address and a ZooKeeper namespace.
AbstractCustomCommandLine() - Constructor for class org.apache.flink.client.cli.AbstractCustomCommandLine
AbstractJobClusterExecutor<ClusterID,ClientFactory extends ClusterClientFactory<ClusterID>> - Class in org.apache.flink.client.deployment.executors: Deprecated.
AbstractJobClusterExecutor(ClientFactory) - Constructor for class org.apache.flink.client.deployment.executors.AbstractJobClusterExecutor: Deprecated.
AbstractSessionClusterExecutor<ClusterID,ClientFactory extends ClusterClientFactory<ClusterID>> - Class in org.apache.flink.client.deployment.executors: An abstract PipelineExecutor used to execute pipelines on an existing (session) cluster.
AbstractSessionClusterExecutor(ClientFactory) - Constructor for class org.apache.flink.client.deployment.executors.AbstractSessionClusterExecutor
addGeneralOptions(Options) - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
addGeneralOptions(Options) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Adds custom options to the existing general options.
addGeneralOptions(Options) - Method in class org.apache.flink.client.cli.DefaultCLI
addGeneralOptions(Options) - Method in class org.apache.flink.client.cli.GenericCLI
ADDRESS_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
addRunOptions(Options) - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
addRunOptions(Options) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Adds custom options to the existing run options.
addRunOptions(Options) - Method in class org.apache.flink.client.cli.GenericCLI
APPLICATION_ARGS - Static variable in class org.apache.flink.client.deployment.application.ApplicationConfiguration
APPLICATION_MAIN_CLASS - Static variable in class org.apache.flink.client.deployment.application.ApplicationConfiguration
ApplicationClusterDeployer - Class in org.apache.flink.client.deployment.application.cli: An entity responsible for submitting an application for execution in "Application Mode", i.e.
ApplicationClusterDeployer(ClusterClientServiceLoader) - Constructor for class org.apache.flink.client.deployment.application.cli.ApplicationClusterDeployer
ApplicationClusterEntryPoint - Class in org.apache.flink.client.deployment.application: Base class for cluster entry points targeting executing applications in "Application Mode".
ApplicationClusterEntryPoint(Configuration, PackagedProgram, ResourceManagerFactory<?>) - Constructor for class org.apache.flink.client.deployment.application.ApplicationClusterEntryPoint
ApplicationConfiguration - Class in org.apache.flink.client.deployment.application: Application-specific configurations.
ApplicationConfiguration(String[], String) - Constructor for class org.apache.flink.client.deployment.application.ApplicationConfiguration
ApplicationDeployer - Interface in org.apache.flink.client.cli: An interface to be used by the CliFrontend to submit user programs for execution.
ApplicationDispatcherBootstrap - Class in org.apache.flink.client.deployment.application: A DispatcherBootstrap used for running the user's main() in "Application Mode" (see FLIP-85).
ApplicationDispatcherBootstrap(PackagedProgram, Collection<JobID>, Configuration, DispatcherGateway, ScheduledExecutor, FatalErrorHandler) - Constructor for class org.apache.flink.client.deployment.application.ApplicationDispatcherBootstrap
ApplicationDispatcherGatewayServiceFactory - Class in org.apache.flink.client.deployment.application: A DispatcherGatewayServiceFactory used when executing a job in Application Mode, i.e.
ApplicationDispatcherGatewayServiceFactory(Configuration, DispatcherFactory, PackagedProgram, RpcService, PartialDispatcherServices) - Constructor for class org.apache.flink.client.deployment.application.ApplicationDispatcherGatewayServiceFactory
ApplicationDispatcherLeaderProcessFactoryFactory - Class in org.apache.flink.client.deployment.application: Factory for a DispatcherLeaderProcessFactoryFactory designed to be used when executing an application in Application Mode.
ApplicationExecutionException - Exception in org.apache.flink.client.deployment.application: A FlinkException thrown in case something during application execution went wrong.
ApplicationExecutionException(String) - Constructor for exception org.apache.flink.client.deployment.application.ApplicationExecutionException
ApplicationExecutionException(Throwable) - Constructor for exception org.apache.flink.client.deployment.application.ApplicationExecutionException
ApplicationExecutionException(String, Throwable) - Constructor for exception org.apache.flink.client.deployment.application.ApplicationExecutionException
ApplicationRunner - Interface in org.apache.flink.client.deployment.application: An interface to be implemented by the entities responsible for application submission for the different deployment environments.
applyToConfiguration(Configuration) - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
applyToConfiguration(Configuration) - Method in class org.apache.flink.client.cli.ProgramOptions
applyToConfiguration(Configuration) - Method in class org.apache.flink.client.deployment.application.ApplicationConfiguration
ARGS_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser

B

build() - Method in class org.apache.flink.client.program.PackagedProgram.Builder
buildUserCodeClassLoader(List<URL>, List<URL>, ClassLoader, Configuration) - Static method in enum org.apache.flink.client.ClientUtils

C

cancel(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executes the CANCEL action.
cancel() - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
cancel() - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
cancel() - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
cancel(JobID) - Method in interface org.apache.flink.client.program.ClusterClient: Cancels a job identified by the job id.
cancel(JobID) - Method in class org.apache.flink.client.program.MiniClusterClient
cancel(JobID) - Method in class org.apache.flink.client.program.rest.RestClusterClient
CancelOptions - Class in org.apache.flink.client.cli: Command line options for the CANCEL command.
CancelOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.CancelOptions
cancelWithSavepoint(JobID, String, SavepointFormatType) - Method in interface org.apache.flink.client.program.ClusterClient: Cancels a job identified by the job id and triggers a savepoint.
cancelWithSavepoint(JobID, String, SavepointFormatType) - Method in class org.apache.flink.client.program.MiniClusterClient
cancelWithSavepoint(JobID, String, SavepointFormatType) - Method in class org.apache.flink.client.program.rest.RestClusterClient
canTranslate(Pipeline) - Method in interface org.apache.flink.client.FlinkPipelineTranslator
canTranslate(Pipeline) - Method in class org.apache.flink.client.PlanTranslator
canTranslate(Pipeline) - Method in class org.apache.flink.client.StreamGraphTranslator
cleanupDirectories(ClusterEntrypoint.ShutdownBehaviour) - Method in class org.apache.flink.client.deployment.application.ApplicationClusterEntryPoint
CliArgsException - Exception in org.apache.flink.client.cli: Special exception that is thrown when the command line parsing fails.
CliArgsException(String) - Constructor for exception org.apache.flink.client.cli.CliArgsException
CliArgsException(String, Throwable) - Constructor for exception org.apache.flink.client.cli.CliArgsException
CLIENT_HEARTBEAT_INTERVAL - Static variable in class org.apache.flink.client.cli.ClientOptions: Time interval for job client to report its heartbeat.
CLIENT_HEARTBEAT_TIMEOUT - Static variable in class org.apache.flink.client.cli.ClientOptions: Timeout for job client to report its heartbeat.
CLIENT_RETRY_PERIOD - Static variable in class org.apache.flink.client.cli.ClientOptions
CLIENT_TIMEOUT - Static variable in class org.apache.flink.client.cli.ClientOptions
ClientOptions - Class in org.apache.flink.client.cli: Describes a client configuration parameter.
ClientOptions() - Constructor for class org.apache.flink.client.cli.ClientOptions
ClientUtils - Enum in org.apache.flink.client: Utility functions for Flink client.
CliFrontend - Class in org.apache.flink.client.cli: Implementation of a simple command line frontend for executing programs.
CliFrontend(Configuration, List<CustomCommandLine>) - Constructor for class org.apache.flink.client.cli.CliFrontend
CliFrontend(Configuration, ClusterClientServiceLoader, List<CustomCommandLine>) - Constructor for class org.apache.flink.client.cli.CliFrontend
CliFrontendParser - Class in org.apache.flink.client.cli: A simple command line parser (based on Apache Commons CLI) that extracts command line options.
CliFrontendParser() - Constructor for class org.apache.flink.client.cli.CliFrontendParser
close() - Method in interface org.apache.flink.client.deployment.ClusterDescriptor
close() - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
close() - Method in interface org.apache.flink.client.program.ClusterClient
close() - Method in class org.apache.flink.client.program.MiniClusterClient
close() - Method in class org.apache.flink.client.program.PackagedProgram
close() - Method in class org.apache.flink.client.program.rest.RestClusterClient
ClusterClient<T> - Interface in org.apache.flink.client.program: Encapsulates the functionality necessary to submit a program to a remote cluster.
ClusterClientFactory<ClusterID> - Interface in org.apache.flink.client.deployment: A factory containing all the necessary information for creating clients to Flink clusters.
ClusterClientJobClientAdapter<ClusterID> - Class in org.apache.flink.client.deployment: An implementation of the JobClient interface that uses a ClusterClient underneath..
ClusterClientJobClientAdapter(ClusterClientProvider<ClusterID>, JobID, ClassLoader) - Constructor for class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
ClusterClientProvider<T> - Interface in org.apache.flink.client.program: Factory for ClusterClients.
ClusterClientServiceLoader - Interface in org.apache.flink.client.deployment: An interface used to discover the appropriate cluster client factory based on the provided Configuration.
ClusterDeploymentException - Exception in org.apache.flink.client.deployment: Class which indicates a problem when deploying a Flink cluster.
ClusterDeploymentException(String) - Constructor for exception org.apache.flink.client.deployment.ClusterDeploymentException
ClusterDeploymentException(Throwable) - Constructor for exception org.apache.flink.client.deployment.ClusterDeploymentException
ClusterDeploymentException(String, Throwable) - Constructor for exception org.apache.flink.client.deployment.ClusterDeploymentException
ClusterDescriptor<T> - Interface in org.apache.flink.client.deployment: A descriptor to deploy a cluster (e.g.
ClusterRetrieveException - Exception in org.apache.flink.client.deployment: Exception which indicates that a cluster could not be retrieved.
ClusterRetrieveException(String) - Constructor for exception org.apache.flink.client.deployment.ClusterRetrieveException
ClusterRetrieveException(Throwable) - Constructor for exception org.apache.flink.client.deployment.ClusterRetrieveException
ClusterRetrieveException(String, Throwable) - Constructor for exception org.apache.flink.client.deployment.ClusterRetrieveException
ClusterSpecification - Class in org.apache.flink.client.deployment: Description of the cluster to start by the ClusterDescriptor.
ClusterSpecification.ClusterSpecificationBuilder - Class in org.apache.flink.client.deployment: Builder for the ClusterSpecification instance.
ClusterSpecificationBuilder() - Constructor for class org.apache.flink.client.deployment.ClusterSpecification.ClusterSpecificationBuilder
CommandLineOptions - Class in org.apache.flink.client.cli: Base class for all options parsed from the command line.
CommandLineOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.CommandLineOptions
configureExecution(Configuration, PackagedProgram) - Static method in class org.apache.flink.client.deployment.application.ApplicationClusterEntryPoint
configurePythonExecution(Configuration, PackagedProgram) - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils
containsPythonDependencyOptions(CommandLine) - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils
ContextEnvironment - Class in org.apache.flink.client.program: Execution Environment for remote execution with the Client.
ContextEnvironment(PipelineExecutorServiceLoader, Configuration, ClassLoader, boolean, boolean) - Constructor for class org.apache.flink.client.program.ContextEnvironment
create(CommandLine) - Static method in class org.apache.flink.client.cli.ProgramOptions
create(DispatcherId, Collection<JobGraph>, Collection<JobResult>, JobGraphWriter, JobResultStore) - Method in class org.apache.flink.client.deployment.application.ApplicationDispatcherGatewayServiceFactory
create(Configuration, DispatcherFactory, PackagedProgram) - Static method in class org.apache.flink.client.deployment.application.ApplicationDispatcherLeaderProcessFactoryFactory
create(String, Iterable<URL>) - Static method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Creates a FromClasspathEntryClassInformationProvider based on the passed job class and classpath.
create(Configuration) - Static method in class org.apache.flink.client.deployment.executors.LocalExecutor
create(File, String, String[], Configuration) - Static method in class org.apache.flink.client.program.DefaultPackagedProgramRetriever: Creates a PackageProgramRetrieverImpl with the given parameters.
create(File, File, String, String[], Configuration) - Static method in class org.apache.flink.client.program.DefaultPackagedProgramRetriever: Creates a PackageProgramRetrieverImpl with the given parameters.
create() - Static method in class org.apache.flink.client.program.PerJobMiniClusterFactory
createClusterDescriptor(Configuration) - Method in interface org.apache.flink.client.deployment.ClusterClientFactory: Create a ClusterDescriptor from the given configuration.
createClusterDescriptor(Configuration) - Method in class org.apache.flink.client.deployment.StandaloneClientFactory
createClusterSpecification() - Method in class org.apache.flink.client.deployment.ClusterSpecification.ClusterSpecificationBuilder
createDispatcherResourceManagerComponentFactory(Configuration) - Method in class org.apache.flink.client.deployment.application.ApplicationClusterEntryPoint
createFactory(JobPersistenceComponentFactory, Executor, RpcService, PartialDispatcherServices, FatalErrorHandler) - Method in class org.apache.flink.client.deployment.application.ApplicationDispatcherLeaderProcessFactoryFactory
createFromClasspath(Iterable<URL>) - Static method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Creates a FromClasspathEntryClassInformationProvider looking for the entry class providing the main method on the passed classpath.
createFromCustomJar(File, String) - Static method in class org.apache.flink.client.deployment.application.FromJarEntryClassInformationProvider: Creates a FromJarEntryClassInformationProvider for a custom Jar archive.
createFromPythonJar() - Static method in class org.apache.flink.client.deployment.application.FromJarEntryClassInformationProvider: Creates a FromJarEntryClassInformationProvider for a job implemented in Python.
createFromSystemClasspath() - Static method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Creates a FromClasspathEntryClassInformationProvider looking for the entry class providing the main method on the system classpath.
createJobGraph(PackagedProgram, Configuration, int, JobID, boolean) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils: Creates a JobGraph with a specified JobID from the given PackagedProgram.
createJobGraph(PackagedProgram, Configuration, int, boolean) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils: Creates a JobGraph with a random JobID from the given PackagedProgram.
createPythonProgramOptions(CommandLine) - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils
createSavepointRestoreSettings(CommandLine) - Static method in class org.apache.flink.client.cli.CliFrontendParser
createSerializableExecutionGraphStore(Configuration, ScheduledExecutor) - Method in class org.apache.flink.client.deployment.application.ApplicationClusterEntryPoint
createWithFactory(Configuration, Function<MiniClusterConfiguration, MiniCluster>) - Static method in class org.apache.flink.client.deployment.executors.LocalExecutor
createWithFactory(Configuration, Function<? super MiniClusterConfiguration, ? extends MiniCluster>) - Static method in class org.apache.flink.client.program.PerJobMiniClusterFactory
createWithJobClassAssumingOnSystemClasspath(String) - Static method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Creates a FromClasspathEntryClassInformationProvider assuming that the passed job class is available on the system classpath.
CustomCommandLine - Interface in org.apache.flink.client.cli: Custom command-line interface to load hooks for the command-line interface.

D

DefaultCLI - Class in org.apache.flink.client.cli: The default CLI which is used for interaction with standalone clusters.
DefaultCLI() - Constructor for class org.apache.flink.client.cli.DefaultCLI
DefaultClusterClientServiceLoader - Class in org.apache.flink.client.deployment: A service provider for cluster client factories.
DefaultClusterClientServiceLoader() - Constructor for class org.apache.flink.client.deployment.DefaultClusterClientServiceLoader
DefaultPackagedProgramRetriever - Class in org.apache.flink.client.program: PackageProgramRetrieverImpl is the default implementation of PackagedProgramRetriever that can either retrieve a PackagedProgram from a specific jar, some provided user classpath or the system classpath.
deployApplicationCluster(ClusterSpecification, ApplicationConfiguration) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Triggers deployment of an application cluster.
deployApplicationCluster(ClusterSpecification, ApplicationConfiguration) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
deployJobCluster(ClusterSpecification, JobGraph, boolean) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Deprecated.
Per-job mode has been deprecated in Flink 1.15 and will be removed in the future. Please use application mode instead.
deployJobCluster(ClusterSpecification, JobGraph, boolean) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
deploySessionCluster(ClusterSpecification) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Triggers deployment of a cluster.
deploySessionCluster(ClusterSpecification) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
DETACHED_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
DetachedApplicationRunner - Class in org.apache.flink.client.deployment.application: An ApplicationRunner which runs the user specified application using the EmbeddedExecutor.
DetachedApplicationRunner(boolean) - Constructor for class org.apache.flink.client.deployment.application.DetachedApplicationRunner
disposeSavepoint(String) - Method in interface org.apache.flink.client.program.ClusterClient: Dispose the savepoint under the given path.
disposeSavepoint(String) - Method in class org.apache.flink.client.program.MiniClusterClient
disposeSavepoint(String) - Method in class org.apache.flink.client.program.rest.RestClusterClient
DynamicPropertiesUtil - Class in org.apache.flink.client.cli: Helper class for supporting dynamic property commandline options in CustomCommandLines.
DynamicPropertiesUtil() - Constructor for class org.apache.flink.client.cli.DynamicPropertiesUtil

E

EmbeddedExecutor - Class in org.apache.flink.client.deployment.application.executors: A base class for executors that invoke directly methods of the Dispatcher and do not go through the REST API.
EmbeddedExecutor(Collection<JobID>, DispatcherGateway, EmbeddedJobClientCreator) - Constructor for class org.apache.flink.client.deployment.application.executors.EmbeddedExecutor: Creates a EmbeddedExecutor.
EmbeddedExecutorFactory - Class in org.apache.flink.client.deployment.application.executors: An PipelineExecutorFactory for the EmbeddedExecutor.
EmbeddedExecutorFactory(Collection<JobID>, DispatcherGateway, ScheduledExecutor) - Constructor for class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorFactory: Creates an EmbeddedExecutorFactory.
EmbeddedExecutorServiceLoader - Class in org.apache.flink.client.deployment.application.executors: A PipelineExecutorServiceLoader that always returns an EmbeddedExecutorFactory.
EmbeddedExecutorServiceLoader(Collection<JobID>, DispatcherGateway, ScheduledExecutor) - Constructor for class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorServiceLoader: Creates an EmbeddedExecutorServiceLoader.
EmbeddedJobClient - Class in org.apache.flink.client.deployment.application: A JobClient with the ability to also submit jobs which uses directly the DispatcherGateway.
EmbeddedJobClient(JobID, DispatcherGateway, ScheduledExecutor, Time, ClassLoader) - Constructor for class org.apache.flink.client.deployment.application.EmbeddedJobClient
EmbeddedJobClientCreator - Interface in org.apache.flink.client.deployment.application.executors: An interface to be implemented by JobClient suppliers.
encodeDynamicProperties(CommandLine, Configuration) - Static method in class org.apache.flink.client.cli.DynamicPropertiesUtil: Parses dynamic properties from the given CommandLine and sets them on the Configuration.
EntryClassInformationProvider - Interface in org.apache.flink.client.deployment.application: EntryClassInformationProvider provides information about the entry class.
entryPointClass - Variable in class org.apache.flink.client.cli.ProgramOptions
execute(Pipeline, Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutor
execute(Pipeline, Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.executors.AbstractJobClusterExecutor: Deprecated.
execute(Pipeline, Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.executors.AbstractSessionClusterExecutor
execute(Pipeline, Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.executors.LocalExecutor
execute(String) - Method in class org.apache.flink.client.program.ContextEnvironment
execute(StreamGraph) - Method in class org.apache.flink.client.program.StreamContextEnvironment
executeAsync(String) - Method in class org.apache.flink.client.program.ContextEnvironment
executeAsync(String) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
executeAsync(StreamGraph) - Method in class org.apache.flink.client.program.StreamContextEnvironment
executeAsync(StreamGraph) - Method in class org.apache.flink.client.program.StreamPlanEnvironment
executeProgram(Configuration, PackagedProgram) - Method in class org.apache.flink.client.cli.CliFrontend
executeProgram(PipelineExecutorServiceLoader, Configuration, PackagedProgram, boolean, boolean) - Static method in enum org.apache.flink.client.ClientUtils
ExecutionConfigAccessor - Class in org.apache.flink.client.cli: Accessor that exposes config settings that are relevant for execution from an underlying Configuration.
ExponentialWaitStrategy - Class in org.apache.flink.client.program.rest.retry: WaitStrategy with exponentially increasing sleep time.
ExponentialWaitStrategy(long, long) - Constructor for class org.apache.flink.client.program.rest.retry.ExponentialWaitStrategy
extractContainedLibraries(URL) - Static method in class org.apache.flink.client.program.PackagedProgram: Takes all JAR files that are contained in this program's JAR file and extracts them to the system's temp directory.
extractProgramArgs(CommandLine) - Method in class org.apache.flink.client.cli.ProgramOptions

F

findFirstManifestAttribute(File, String...) - Static method in class org.apache.flink.client.deployment.application.JarManifestParser: Returns the value of the first manifest attribute found in the provided JAR file.
FlinkPipelineTranslationUtil - Class in org.apache.flink.client: Utility for transforming FlinkPipelines into a JobGraph.
FlinkPipelineTranslationUtil() - Constructor for class org.apache.flink.client.FlinkPipelineTranslationUtil
FlinkPipelineTranslator - Interface in org.apache.flink.client: This can be used to turn a Pipeline into a JobGraph.
FromClasspathEntryClassInformationProvider - Class in org.apache.flink.client.deployment.application: FromClasspathEntryClassInformationProvider assumes the passed job class being available on some classpath.
fromConfiguration(Configuration) - Static method in class org.apache.flink.client.cli.ExecutionConfigAccessor: Creates an ExecutionConfigAccessor based on the provided Configuration.
fromConfiguration(Configuration) - Static method in class org.apache.flink.client.deployment.application.ApplicationConfiguration
fromConfiguration(Configuration) - Static method in class org.apache.flink.client.program.rest.RestClusterClientConfiguration
FromJarEntryClassInformationProvider - Class in org.apache.flink.client.deployment.application: FromJarEntryClassInformationProvider is used for cases where the Jar archive is explicitly specified.
fromJobResult(JobResult, ClassLoader) - Static method in exception org.apache.flink.client.deployment.application.UnsuccessfulExecutionException
fromProgramOptions(ProgramOptions, List<T>) - Static method in class org.apache.flink.client.cli.ExecutionConfigAccessor: Creates an ExecutionConfigAccessor based on the provided ProgramOptions as provided by the user through the CLI.

G

GenericCLI - Class in org.apache.flink.client.cli: A generic implementation of the CustomCommandLine that only expects the execution.target parameter to be explicitly specified and simply forwards the rest of the options specified with -D to the corresponding PipelineExecutor for further parsing.
GenericCLI(Configuration, String) - Constructor for class org.apache.flink.client.cli.GenericCLI
getAccumulators() - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
getAccumulators() - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
getAccumulators() - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
getAccumulators(JobID) - Method in interface org.apache.flink.client.program.ClusterClient: Requests and returns the accumulators for the given job identifier.
getAccumulators(JobID, ClassLoader) - Method in interface org.apache.flink.client.program.ClusterClient: Requests and returns the accumulators for the given job identifier.
getAccumulators(JobID, ClassLoader) - Method in class org.apache.flink.client.program.MiniClusterClient
getAccumulators(JobID, ClassLoader) - Method in class org.apache.flink.client.program.rest.RestClusterClient
getApplicationClassName() - Method in class org.apache.flink.client.deployment.application.ApplicationConfiguration
getApplicationModeTargetNames() - Method in interface org.apache.flink.client.deployment.ClusterClientServiceLoader: Loads and returns a stream of the names of all available execution target names for Application Mode.
getApplicationModeTargetNames() - Method in class org.apache.flink.client.deployment.DefaultClusterClientServiceLoader
getApplicationTargetName() - Method in interface org.apache.flink.client.deployment.ClusterClientFactory: Returns the option to be used when trying to execute an application in Application Mode using this cluster client factory, or an Optional.empty() if the environment of this cluster client factory does not support Application Mode.
getArgs() - Method in class org.apache.flink.client.cli.CancelOptions
getArgs() - Method in class org.apache.flink.client.cli.SavepointOptions
getArguments() - Method in class org.apache.flink.client.program.PackagedProgram
getAwaitLeaderTimeout() - Method in class org.apache.flink.client.program.rest.RestClusterClientConfiguration
getClasspaths() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getClasspaths() - Method in class org.apache.flink.client.cli.ProgramOptions
getClasspaths() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the classpaths that are required by the program.
getClusterClient() - Method in interface org.apache.flink.client.program.ClusterClientProvider: Creates and returns a new ClusterClient.
getClusterClientFactory(Configuration) - Method in interface org.apache.flink.client.deployment.ClusterClientServiceLoader: Discovers the appropriate ClusterClientFactory based on the provided configuration.
getClusterClientFactory(Configuration) - Method in class org.apache.flink.client.deployment.DefaultClusterClientServiceLoader
getClusterDescription() - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Returns a String containing details about the cluster (NodeManagers, available memory, ...).
getClusterDescription() - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
getClusterId(Configuration) - Method in interface org.apache.flink.client.deployment.ClusterClientFactory: Returns the cluster id if a cluster id is specified in the provided configuration, otherwise it returns null.
getClusterId(Configuration) - Method in class org.apache.flink.client.deployment.StandaloneClientFactory
getClusterId() - Method in interface org.apache.flink.client.program.ClusterClient: Returns the cluster id identifying the cluster to which the client is connected.
getClusterId() - Method in class org.apache.flink.client.program.MiniClusterClient
getClusterId() - Method in class org.apache.flink.client.program.rest.RestClusterClient
getClusterOverview() - Method in class org.apache.flink.client.program.rest.RestClusterClient: Get an overview of the Flink cluster.
getClusterSpecification(Configuration) - Method in class org.apache.flink.client.deployment.AbstractContainerizedClusterClientFactory
getClusterSpecification(Configuration) - Method in interface org.apache.flink.client.deployment.ClusterClientFactory: Returns the ClusterSpecification specified by the configuration and the command line options.
getClusterSpecification(Configuration) - Method in class org.apache.flink.client.deployment.StandaloneClientFactory
getCommandLine(Options, String[], boolean) - Method in class org.apache.flink.client.cli.CliFrontend
getConfiguration() - Method in class org.apache.flink.client.cli.CliFrontend: Getter which returns a copy of the associated configuration.
getConfigurationDirectoryFromEnv() - Static method in class org.apache.flink.client.cli.CliFrontend
getCustomCommandLineOptions() - Method in class org.apache.flink.client.cli.CliFrontend
getDescription() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the description provided by the Program class.
getDetachedMode() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getDetachedMode() - Method in class org.apache.flink.client.cli.ProgramOptions
getEntryPointClassName() - Method in class org.apache.flink.client.cli.ProgramOptions
getExecutor(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorFactory
getExecutor(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorFactory
getExecutor(Configuration) - Method in class org.apache.flink.client.deployment.executors.LocalExecutorFactory
getExecutor(Configuration) - Method in class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
getExecutorFactory(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorServiceLoader
getExecutorFactory(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorServiceLoader
getExecutorNames() - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorServiceLoader
getExecutorNames() - Method in class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorServiceLoader
getFlinkConfiguration() - Method in interface org.apache.flink.client.program.ClusterClient: Return the Flink configuration object.
getFlinkConfiguration() - Method in class org.apache.flink.client.program.MiniClusterClient
getFlinkConfiguration() - Method in class org.apache.flink.client.program.rest.RestClusterClient
getFormatType() - Method in class org.apache.flink.client.cli.CancelOptions
getFormatType() - Method in class org.apache.flink.client.cli.SavepointOptions
getId() - Method in interface org.apache.flink.client.cli.CustomCommandLine: Gets the unique identifier of this CustomCommandLine.
getId() - Method in class org.apache.flink.client.cli.DefaultCLI
getId() - Method in class org.apache.flink.client.cli.GenericCLI
getInstance() - Static method in class org.apache.flink.client.deployment.StandaloneClusterId
getJarFile() - Method in interface org.apache.flink.client.deployment.application.EntryClassInformationProvider: Returns the File referring to the Jar file that contains the job class or no File if the job class is located on the classpath.
getJarFile() - Method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Always returns an empty Optional because this implementation relies on the JAR archive being available on either the user or the system classpath.
getJarFile() - Method in class org.apache.flink.client.deployment.application.FromJarEntryClassInformationProvider: Returns the specified jarFile.
getJarFilePath() - Method in class org.apache.flink.client.cli.ProgramOptions
getJarFilePath() - Method in class org.apache.flink.client.cli.SavepointOptions
getJars() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getJobClassName() - Method in interface org.apache.flink.client.deployment.application.EntryClassInformationProvider: Returns the name of the job class or an empty Optional if the job class name cannot be provided.
getJobClassName() - Method in class org.apache.flink.client.deployment.application.FromClasspathEntryClassInformationProvider: Returns the job class name if it could be derived from the specified classpath or was explicitly specified.
getJobClassName() - Method in class org.apache.flink.client.deployment.application.FromJarEntryClassInformationProvider: Returns the specified job class name that is either available in the corresponding jarFile.
getJobClient(JobID, ClassLoader) - Method in interface org.apache.flink.client.deployment.application.executors.EmbeddedJobClientCreator: Creates a JobClient that is adequate for the context in which the job is executed.
getJobDetails(JobID) - Method in class org.apache.flink.client.program.rest.RestClusterClient: Requests the job details.
getJobExecutionResult() - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
getJobExecutionResult() - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
getJobExecutionResult() - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
getJobGraph(Pipeline, Configuration, ClassLoader) - Static method in class org.apache.flink.client.deployment.executors.PipelineExecutorUtils: Creates the JobGraph corresponding to the provided Pipeline.
getJobGraph(ClassLoader, Pipeline, Configuration, int) - Static method in class org.apache.flink.client.FlinkPipelineTranslationUtil: Transmogrifies the given Pipeline to a JobGraph.
getJobGraphUnderUserClassLoader(ClassLoader, Pipeline, Configuration, int) - Static method in class org.apache.flink.client.FlinkPipelineTranslationUtil: Transmogrifies the given Pipeline under the userClassloader to a JobGraph.
getJobID() - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
getJobID() - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
getJobID() - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
getJobJarAndDependencies() - Method in class org.apache.flink.client.program.PackagedProgram: Returns all provided libraries needed to run the program.
getJobJarAndDependencies(File, String) - Static method in class org.apache.flink.client.program.PackagedProgram: Returns all provided libraries needed to run the program.
getJobStatus() - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
getJobStatus() - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
getJobStatus() - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
getJobStatus(JobID) - Method in interface org.apache.flink.client.program.ClusterClient: Requests the JobStatus of the job with the given JobID.
getJobStatus(JobID) - Method in class org.apache.flink.client.program.MiniClusterClient
getJobStatus(JobID) - Method in class org.apache.flink.client.program.rest.RestClusterClient
getMainClassName() - Method in class org.apache.flink.client.program.PackagedProgram
getMasterMemoryMB() - Method in class org.apache.flink.client.deployment.ClusterSpecification
getName() - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorFactory
getName() - Method in class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorFactory
getName() - Method in class org.apache.flink.client.deployment.executors.LocalExecutorFactory
getName() - Method in class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
getPackagedProgram() - Method in class org.apache.flink.client.program.DefaultPackagedProgramRetriever
getPackagedProgram() - Method in interface org.apache.flink.client.program.PackagedProgramRetriever: Retrieve the PackagedProgram.
getParallelism() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getParallelism() - Method in class org.apache.flink.client.cli.ProgramOptions
getPipeline() - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
getPipeline() - Method in class org.apache.flink.client.program.StreamPlanEnvironment
getPipelineFromProgram(PackagedProgram, Configuration, int, boolean) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
getProgramArgs() - Method in class org.apache.flink.client.cli.ProgramOptions
getProgramArguments() - Method in class org.apache.flink.client.deployment.application.ApplicationConfiguration
getPythonDriverClassName() - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
getPythonJar() - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
getRestClientConfiguration() - Method in class org.apache.flink.client.program.rest.RestClusterClientConfiguration
getRetryDelay() - Method in class org.apache.flink.client.program.rest.RestClusterClientConfiguration
getRetryMaxAttempts() - Method in class org.apache.flink.client.program.rest.RestClusterClientConfiguration
getRunCommandOptions() - Static method in class org.apache.flink.client.cli.CliFrontendParser
getSavepointPath() - Method in class org.apache.flink.client.cli.SavepointOptions
getSavepointRestoreSettings() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getSavepointRestoreSettings() - Method in class org.apache.flink.client.cli.ProgramOptions
getSavepointSettings() - Method in class org.apache.flink.client.program.PackagedProgram
getSavepointTargetDirectory() - Method in class org.apache.flink.client.cli.CancelOptions
getSlotsPerTaskManager() - Method in class org.apache.flink.client.deployment.ClusterSpecification
getStatus() - Method in exception org.apache.flink.client.deployment.application.UnsuccessfulExecutionException
getTaskManagerMemoryMB() - Method in class org.apache.flink.client.deployment.ClusterSpecification
getUserCodeClassLoader() - Method in class org.apache.flink.client.program.PackagedProgram: Gets the ClassLoader that must be used to load user code classes.
getWebInterfaceURL() - Method in interface org.apache.flink.client.program.ClusterClient: Returns an URL (as a string) to the cluster web interface.
getWebInterfaceURL() - Method in class org.apache.flink.client.program.MiniClusterClient
getWebInterfaceURL() - Method in class org.apache.flink.client.program.rest.RestClusterClient

H

handleCliArgsException(CliArgsException, Logger) - Static method in class org.apache.flink.client.cli.AbstractCustomCommandLine
handleError(Throwable, Logger) - Static method in class org.apache.flink.client.cli.AbstractCustomCommandLine

I

ID - Static variable in class org.apache.flink.client.cli.DefaultCLI
info(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executes the info action.
invalidateClusterDataset(AbstractID, Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.executors.AbstractSessionClusterExecutor
invalidateClusterDataset(AbstractID) - Method in interface org.apache.flink.client.program.ClusterClient: Invalidate the cached intermediate dataset with the given id.
invalidateClusterDataset(AbstractID) - Method in class org.apache.flink.client.program.MiniClusterClient
invalidateClusterDataset(AbstractID) - Method in class org.apache.flink.client.program.rest.RestClusterClient
invokeInteractiveModeForExecution() - Method in class org.apache.flink.client.program.PackagedProgram: This method assumes that the context environment is prepared, or the execution will be a local execution by default.
isActive(CommandLine) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Signals whether the custom command-line wants to execute or not.
isActive(CommandLine) - Method in class org.apache.flink.client.cli.DefaultCLI
isActive(CommandLine) - Method in class org.apache.flink.client.cli.GenericCLI
isCompatibleWith(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutorFactory
isCompatibleWith(Configuration) - Method in class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorFactory
isCompatibleWith(Configuration) - Method in interface org.apache.flink.client.deployment.ClusterClientFactory: Returns true if the current ClusterClientFactory is compatible with the provided configuration, false otherwise.
isCompatibleWith(Configuration) - Method in class org.apache.flink.client.deployment.executors.LocalExecutorFactory
isCompatibleWith(Configuration) - Method in class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
isCompatibleWith(Configuration) - Method in class org.apache.flink.client.deployment.StandaloneClientFactory
isDispose() - Method in class org.apache.flink.client.cli.SavepointOptions
isPrintHelp() - Method in class org.apache.flink.client.cli.CommandLineOptions
isPython(String) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
isPython(String[]) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
isPythonEntryPoint(CommandLine) - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils
isShutdownOnAttachedExit() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
isShutdownOnAttachedExit() - Method in class org.apache.flink.client.cli.ProgramOptions
isWithSavepoint() - Method in class org.apache.flink.client.cli.CancelOptions

J

JarManifestParser - Class in org.apache.flink.client.deployment.application: Utility that parses JAR manifest attributes.
JarManifestParser() - Constructor for class org.apache.flink.client.deployment.application.JarManifestParser

K

killCluster(T) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Terminates the cluster with the given cluster id.
killCluster(StandaloneClusterId) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor

L

list(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executes the list action.
listCompletedClusterDatasetIds(Configuration, ClassLoader) - Method in class org.apache.flink.client.deployment.executors.AbstractSessionClusterExecutor
listCompletedClusterDatasetIds() - Method in interface org.apache.flink.client.program.ClusterClient: Return a set of ids of the completed cluster datasets.
listCompletedClusterDatasetIds() - Method in class org.apache.flink.client.program.MiniClusterClient
listCompletedClusterDatasetIds() - Method in class org.apache.flink.client.program.rest.RestClusterClient
listJobs() - Method in interface org.apache.flink.client.program.ClusterClient: Lists the currently running and finished jobs on the cluster.
listJobs() - Method in class org.apache.flink.client.program.MiniClusterClient
listJobs() - Method in class org.apache.flink.client.program.rest.RestClusterClient
ListOptions - Class in org.apache.flink.client.cli: Command line options for the LIST command.
ListOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.ListOptions
loadCustomCommandLines(Configuration, String) - Static method in class org.apache.flink.client.cli.CliFrontend
LocalExecutor - Class in org.apache.flink.client.deployment.executors: An PipelineExecutor for executing a Pipeline locally.
LocalExecutorFactory - Class in org.apache.flink.client.deployment.executors: An PipelineExecutorFactory for local executors.
LocalExecutorFactory() - Constructor for class org.apache.flink.client.deployment.executors.LocalExecutorFactory

M

main(String[]) - Static method in class org.apache.flink.client.cli.CliFrontend: Submits the job based on the arguments.
MANIFEST_ATTRIBUTE_ASSEMBLER_CLASS - Static variable in class org.apache.flink.client.program.PackagedProgram: Property name of the entry in JAR manifest file that describes the Flink specific entry point.
MANIFEST_ATTRIBUTE_MAIN_CLASS - Static variable in class org.apache.flink.client.program.PackagedProgram: Property name of the entry in JAR manifest file that describes the class with the main method.
mergeOptions(Options, Options) - Static method in class org.apache.flink.client.cli.CliFrontendParser: Merges the given Options into a new Options object.
MiniClusterClient - Class in org.apache.flink.client.program: Client to interact with a MiniCluster.
MiniClusterClient(Configuration, MiniCluster) - Constructor for class org.apache.flink.client.program.MiniClusterClient
MiniClusterClient.MiniClusterId - Enum in org.apache.flink.client.program: The type of the Cluster ID for the local MiniCluster.
MutatedConfigurationException - Exception in org.apache.flink.client.program: If DeploymentOptions.PROGRAM_CONFIG_ENABLED is disabled, configurations in the user jar will throw this exception.
MutatedConfigurationException(Collection<String>) - Constructor for exception org.apache.flink.client.program.MutatedConfigurationException

N

NAME - Static variable in class org.apache.flink.client.deployment.application.executors.EmbeddedExecutor
NAME - Static variable in class org.apache.flink.client.deployment.executors.LocalExecutor
NAME - Static variable in class org.apache.flink.client.deployment.executors.RemoteExecutor
newBuilder() - Static method in class org.apache.flink.client.program.PackagedProgram

O

OptimizerPlanEnvironment - Class in org.apache.flink.client.program: An ExecutionEnvironment that never executes a job but only extracts the Pipeline.
OptimizerPlanEnvironment(Configuration, ClassLoader, int) - Constructor for class org.apache.flink.client.program.OptimizerPlanEnvironment
org.apache.flink.client - package org.apache.flink.client
org.apache.flink.client.cli - package org.apache.flink.client.cli
org.apache.flink.client.deployment - package org.apache.flink.client.deployment
org.apache.flink.client.deployment.application - package org.apache.flink.client.deployment.application
org.apache.flink.client.deployment.application.cli - package org.apache.flink.client.deployment.application.cli
org.apache.flink.client.deployment.application.executors - package org.apache.flink.client.deployment.application.executors
org.apache.flink.client.deployment.executors - package org.apache.flink.client.deployment.executors
org.apache.flink.client.program - package org.apache.flink.client.program
org.apache.flink.client.program.rest - package org.apache.flink.client.program.rest
org.apache.flink.client.program.rest.retry - package org.apache.flink.client.program.rest.retry

P

PackagedProgram - Class in org.apache.flink.client.program: This class encapsulates represents a program, packaged in a jar file.
PackagedProgram.Builder - Class in org.apache.flink.client.program: A Builder For PackagedProgram.
PackagedProgramRetriever - Interface in org.apache.flink.client.program: Interface which allows to retrieve the PackagedProgram.
PackagedProgramUtils - Enum in org.apache.flink.client.program: Utility class for PackagedProgram related operations.
PARALLELISM_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
parse(Options, String[], boolean) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseAndRun(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Parses the command line arguments and starts the requested action.
parseCommandLineOptions(String[], boolean) - Method in interface org.apache.flink.client.cli.CustomCommandLine
PerJobMiniClusterFactory - Class in org.apache.flink.client.program: Starts a MiniCluster for every submitted job.
PipelineExecutorUtils - Class in org.apache.flink.client.deployment.executors: Utility class with method related to job execution.
PipelineExecutorUtils() - Constructor for class org.apache.flink.client.deployment.executors.PipelineExecutorUtils
PlanTranslator - Class in org.apache.flink.client: FlinkPipelineTranslator for DataSet API Plans.
PlanTranslator() - Constructor for class org.apache.flink.client.PlanTranslator
printHelp(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser: Prints the help for the client.
printHelpForCancel(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForInfo() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForList(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForRun(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForRunApplication(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForSavepoint(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForStop(Collection<CustomCommandLine>) - Static method in class org.apache.flink.client.cli.CliFrontendParser
printUsage() - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
ProgramAbortException - Error in org.apache.flink.client.program: A special exception used to abort programs when the caller is only interested in the program plan, rather than in the full execution.
ProgramAbortException() - Constructor for error org.apache.flink.client.program.ProgramAbortException
ProgramAbortException(Throwable) - Constructor for error org.apache.flink.client.program.ProgramAbortException: Creates a ProgramAbortException for the given exception.
ProgramInvocationException - Exception in org.apache.flink.client.program: Exception used to indicate that there is an error during the invocation of a Flink program.
ProgramInvocationException(String) - Constructor for exception org.apache.flink.client.program.ProgramInvocationException: Creates a ProgramInvocationException with the given message.
ProgramInvocationException(String, JobID) - Constructor for exception org.apache.flink.client.program.ProgramInvocationException: Creates a ProgramInvocationException with the given message which contains job id.
ProgramInvocationException(Throwable) - Constructor for exception org.apache.flink.client.program.ProgramInvocationException: Creates a ProgramInvocationException for the given exception.
ProgramInvocationException(String, Throwable) - Constructor for exception org.apache.flink.client.program.ProgramInvocationException: Creates a ProgramInvocationException for the given exception with an additional message.
ProgramInvocationException(String, JobID, Throwable) - Constructor for exception org.apache.flink.client.program.ProgramInvocationException: Creates a ProgramInvocationException for the given exception with an additional message which contains job id.
ProgramMissingJobException - Exception in org.apache.flink.client.program: Exception used to indicate that no job was executed during the invocation of a Flink program.
ProgramMissingJobException(String) - Constructor for exception org.apache.flink.client.program.ProgramMissingJobException
ProgramOptions - Class in org.apache.flink.client.cli: Base class for command line options that refer to a JAR file program.
ProgramOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.ProgramOptions
ProgramOptionsUtils - Enum in org.apache.flink.client.cli: Utility class for ProgramOptions.
ProgramParametrizationException - Exception in org.apache.flink.client.program: Exception used to indicate that there is an error in the parametrization of a Flink program.
ProgramParametrizationException(String) - Constructor for exception org.apache.flink.client.program.ProgramParametrizationException: Creates a ProgramParametrizationException with the given message.
PY_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYARCHIVE_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYCLIENTEXEC_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYEXEC_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYFILES_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYMODULE_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYREQUIREMENTS_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
PYTHON_PATH - Static variable in class org.apache.flink.client.cli.CliFrontendParser

R

RemoteExecutor - Class in org.apache.flink.client.deployment.executors: The PipelineExecutor to be used when executing a job on an already running cluster.
RemoteExecutor() - Constructor for class org.apache.flink.client.deployment.executors.RemoteExecutor
RemoteExecutorFactory - Class in org.apache.flink.client.deployment.executors: An PipelineExecutorFactory for remote executors.
RemoteExecutorFactory() - Constructor for class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
reportHeartbeat(long) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
reportHeartbeat(JobID, long) - Method in interface org.apache.flink.client.program.ClusterClient: The client reports the heartbeat to the dispatcher for aliveness.
reportHeartbeat(JobID, long) - Method in class org.apache.flink.client.program.MiniClusterClient
reportHeartbeat(JobID, long) - Method in class org.apache.flink.client.program.rest.RestClusterClient
reportHeartbeatPeriodically(JobClient, long, long) - Static method in enum org.apache.flink.client.ClientUtils: The client reports the heartbeat to the dispatcher for aliveness.
requestJobResult(JobID) - Method in interface org.apache.flink.client.program.ClusterClient: Request the JobResult for the given JobID.
requestJobResult(JobID) - Method in class org.apache.flink.client.program.MiniClusterClient
requestJobResult(JobID) - Method in class org.apache.flink.client.program.rest.RestClusterClient: Requests the JobResult for the given JobID.
resolveURI(String) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils
RestClusterClient<T> - Class in org.apache.flink.client.program.rest: A ClusterClient implementation that communicates via HTTP REST requests.
RestClusterClient(Configuration, T) - Constructor for class org.apache.flink.client.program.rest.RestClusterClient
RestClusterClient(Configuration, T, ClientHighAvailabilityServicesFactory) - Constructor for class org.apache.flink.client.program.rest.RestClusterClient
RestClusterClientConfiguration - Class in org.apache.flink.client.program.rest: A configuration object for RestClusterClients.
retrieve(T) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Retrieves an existing Flink Cluster.
retrieve(StandaloneClusterId) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
run(Configuration, ApplicationConfiguration) - Method in interface org.apache.flink.client.cli.ApplicationDeployer: Submits a user program for execution and runs the main user method on the cluster.
run(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executions the run action.
run(DispatcherGateway, PackagedProgram, Configuration) - Method in interface org.apache.flink.client.deployment.application.ApplicationRunner: Runs the application using the provided dispatcherGateway.
run(Configuration, ApplicationConfiguration) - Method in class org.apache.flink.client.deployment.application.cli.ApplicationClusterDeployer
run(DispatcherGateway, PackagedProgram, Configuration) - Method in class org.apache.flink.client.deployment.application.DetachedApplicationRunner
runApplication(String[]) - Method in class org.apache.flink.client.cli.CliFrontend

S

savepoint(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executes the SAVEPOINT action.
SAVEPOINT_ALLOW_NON_RESTORED_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
SAVEPOINT_PATH_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
SAVEPOINT_RESTORE_MODE - Static variable in class org.apache.flink.client.cli.CliFrontendParser
SavepointOptions - Class in org.apache.flink.client.cli: Command line options for the SAVEPOINT command.
SavepointOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.SavepointOptions
sendCoordinationRequest(OperatorID, CoordinationRequest) - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
sendCoordinationRequest(OperatorID, CoordinationRequest) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
sendCoordinationRequest(JobID, OperatorID, CoordinationRequest) - Method in interface org.apache.flink.client.program.ClusterClient: Sends out a request to a specified coordinator and return the response.
sendCoordinationRequest(JobID, OperatorID, CoordinationRequest) - Method in class org.apache.flink.client.program.MiniClusterClient
sendCoordinationRequest(JobID, OperatorID, CoordinationRequest) - Method in class org.apache.flink.client.program.rest.RestClusterClient
sendRequest(M, U, R) - Method in class org.apache.flink.client.program.rest.RestClusterClient
setArguments(String...) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
setAsContext(PipelineExecutorServiceLoader, Configuration, ClassLoader, boolean, boolean) - Static method in class org.apache.flink.client.program.ContextEnvironment
setAsContext() - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
setAsContext(PipelineExecutorServiceLoader, Configuration, ClassLoader, boolean, boolean) - Static method in class org.apache.flink.client.program.StreamContextEnvironment
setAsContext() - Method in class org.apache.flink.client.program.StreamPlanEnvironment
setConfiguration(Configuration) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
setEntryPointClassName(String) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
setJarFile(File) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
setMasterMemoryMB(int) - Method in class org.apache.flink.client.deployment.ClusterSpecification.ClusterSpecificationBuilder
setSavepointRestoreSettings(SavepointRestoreSettings) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
setSlotsPerTaskManager(int) - Method in class org.apache.flink.client.deployment.ClusterSpecification.ClusterSpecificationBuilder
setTaskManagerMemoryMB(int) - Method in class org.apache.flink.client.deployment.ClusterSpecification.ClusterSpecificationBuilder
setUserClassPaths(List<URL>) - Method in class org.apache.flink.client.program.PackagedProgram.Builder
showAll() - Method in class org.apache.flink.client.cli.ListOptions
showRunning() - Method in class org.apache.flink.client.cli.ListOptions
showScheduled() - Method in class org.apache.flink.client.cli.ListOptions
SHUTDOWN_IF_ATTACHED_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
shutDownCluster() - Method in interface org.apache.flink.client.program.ClusterClient: Shut down the cluster that this client communicate with.
shutDownCluster() - Method in class org.apache.flink.client.program.MiniClusterClient
shutDownCluster() - Method in class org.apache.flink.client.program.rest.RestClusterClient
sleepTime(long) - Method in class org.apache.flink.client.program.rest.retry.ExponentialWaitStrategy
sleepTime(long) - Method in interface org.apache.flink.client.program.rest.retry.WaitStrategy: Returns the time to wait until the next attempt.
StandaloneClientFactory - Class in org.apache.flink.client.deployment: A ClusterClientFactory for a standalone cluster, i.e.
StandaloneClientFactory() - Constructor for class org.apache.flink.client.deployment.StandaloneClientFactory
StandaloneClusterDescriptor - Class in org.apache.flink.client.deployment: A deployment descriptor for an existing cluster.
StandaloneClusterDescriptor(Configuration) - Constructor for class org.apache.flink.client.deployment.StandaloneClusterDescriptor
StandaloneClusterId - Class in org.apache.flink.client.deployment: Identifier for standalone clusters.
stop(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executes the STOP action.
stop() - Method in class org.apache.flink.client.deployment.application.ApplicationDispatcherBootstrap
STOP_AND_DRAIN - Static variable in class org.apache.flink.client.cli.CliFrontendParser
STOP_WITH_SAVEPOINT_PATH - Static variable in class org.apache.flink.client.cli.CliFrontendParser
stopWithSavepoint(boolean, String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
stopWithSavepoint(boolean, String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
stopWithSavepoint(boolean, String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
stopWithSavepoint(JobID, boolean, String, SavepointFormatType) - Method in interface org.apache.flink.client.program.ClusterClient: Stops a program on Flink cluster whose job-manager is configured in this client's configuration.
stopWithSavepoint(JobID, boolean, String, SavepointFormatType) - Method in class org.apache.flink.client.program.MiniClusterClient
stopWithSavepoint(JobID, boolean, String, SavepointFormatType) - Method in class org.apache.flink.client.program.rest.RestClusterClient
StreamContextEnvironment - Class in org.apache.flink.client.program: Special StreamExecutionEnvironment that will be used in cases where the CLI client or testing utilities create a StreamExecutionEnvironment that should be used when StreamExecutionEnvironment.getExecutionEnvironment() is called.
StreamContextEnvironment(PipelineExecutorServiceLoader, Configuration, ClassLoader, boolean, boolean) - Constructor for class org.apache.flink.client.program.StreamContextEnvironment
StreamContextEnvironment(PipelineExecutorServiceLoader, Configuration, Configuration, ClassLoader, boolean, boolean, boolean, Collection<String>) - Constructor for class org.apache.flink.client.program.StreamContextEnvironment
StreamGraphTranslator - Class in org.apache.flink.client: FlinkPipelineTranslator for DataStream API StreamGraphs.
StreamGraphTranslator(ClassLoader) - Constructor for class org.apache.flink.client.StreamGraphTranslator
StreamPlanEnvironment - Class in org.apache.flink.client.program: A special StreamExecutionEnvironment that is used in the web frontend when generating a user-inspectable graph of a streaming job.
StreamPlanEnvironment(Configuration, ClassLoader, int) - Constructor for class org.apache.flink.client.program.StreamPlanEnvironment
submitJob(JobGraph) - Method in interface org.apache.flink.client.program.ClusterClient: Submit the given JobGraph to the cluster.
submitJob(JobGraph) - Method in class org.apache.flink.client.program.MiniClusterClient
submitJob(JobGraph, ClassLoader) - Method in class org.apache.flink.client.program.PerJobMiniClusterFactory: Starts a MiniCluster and submits a job.
submitJob(JobGraph) - Method in class org.apache.flink.client.program.rest.RestClusterClient

T

toConfiguration(CommandLine) - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
toConfiguration(CommandLine) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Materializes the command line arguments in the given CommandLine to a Configuration and returns it.
toConfiguration(CommandLine) - Method in class org.apache.flink.client.cli.DefaultCLI
toConfiguration(CommandLine) - Method in class org.apache.flink.client.cli.GenericCLI
toString() - Method in class org.apache.flink.client.deployment.ClusterSpecification
toString() - Method in class org.apache.flink.client.program.ContextEnvironment
translateToJobGraph(Pipeline, Configuration, int) - Method in interface org.apache.flink.client.FlinkPipelineTranslator: Creates a JobGraph from the given Pipeline and attaches the given jar files and classpaths to the JobGraph.
translateToJobGraph(Pipeline, Configuration, int) - Method in class org.apache.flink.client.PlanTranslator
translateToJobGraph(Pipeline, Configuration, int) - Method in class org.apache.flink.client.StreamGraphTranslator
translateToJSONExecutionPlan(ClassLoader, Pipeline) - Static method in class org.apache.flink.client.FlinkPipelineTranslationUtil: Extracts the execution plan (as JSON) from the given Pipeline.
translateToJSONExecutionPlan(Pipeline) - Method in interface org.apache.flink.client.FlinkPipelineTranslator: Extracts the execution plan (as JSON) from the given Pipeline.
translateToJSONExecutionPlan(Pipeline) - Method in class org.apache.flink.client.PlanTranslator
translateToJSONExecutionPlan(Pipeline) - Method in class org.apache.flink.client.StreamGraphTranslator
triggerSavepoint(String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.application.EmbeddedJobClient
triggerSavepoint(String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.application.WebSubmissionJobClient
triggerSavepoint(String, SavepointFormatType) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
triggerSavepoint(JobID, String, SavepointFormatType) - Method in interface org.apache.flink.client.program.ClusterClient: Triggers a savepoint for the job identified by the job id.
triggerSavepoint(JobID, String, SavepointFormatType) - Method in class org.apache.flink.client.program.MiniClusterClient
triggerSavepoint(JobID, String, SavepointFormatType) - Method in class org.apache.flink.client.program.rest.RestClusterClient

U

unsetAsContext() - Static method in class org.apache.flink.client.program.ContextEnvironment
unsetAsContext() - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
unsetAsContext() - Static method in class org.apache.flink.client.program.StreamContextEnvironment
unsetAsContext() - Method in class org.apache.flink.client.program.StreamPlanEnvironment
UnsuccessfulExecutionException - Exception in org.apache.flink.client.deployment.application: Exception that signals the failure of an application with a given ApplicationStatus.
UnsuccessfulExecutionException(JobID, ApplicationStatus, String, Throwable) - Constructor for exception org.apache.flink.client.deployment.application.UnsuccessfulExecutionException
updateJobResourceRequirements(JobID, JobResourceRequirements) - Method in class org.apache.flink.client.program.rest.RestClusterClient: Update JobResourceRequirements of a given job.

V

validate() - Method in class org.apache.flink.client.cli.ProgramOptions
validateAndGetActiveCommandLine(CommandLine) - Method in class org.apache.flink.client.cli.CliFrontend: Gets the custom command-line for the arguments.
valueOf(String) - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.flink.client.ClientUtils: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.flink.client.program.MiniClusterClient.MiniClusterId: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum org.apache.flink.client.program.PackagedProgramUtils: Returns the enum constant of this type with the specified name.
values() - Static method in enum org.apache.flink.client.cli.ProgramOptionsUtils: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.flink.client.ClientUtils: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.flink.client.program.MiniClusterClient.MiniClusterId: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Static method in enum org.apache.flink.client.program.PackagedProgramUtils: Returns an array containing the constants of this enum type, in the order they are declared.

W

WaitStrategy - Interface in org.apache.flink.client.program.rest.retry: Operations that are polling for a result to arrive require a waiting time between consecutive polls.
waitUntilJobInitializationFinished(SupplierWithException<JobStatus, Exception>, SupplierWithException<JobResult, Exception>, ClassLoader) - Static method in enum org.apache.flink.client.ClientUtils: This method blocks until the job status is not INITIALIZING anymore.
WebSubmissionExecutorFactory - Class in org.apache.flink.client.deployment.application.executors: A PipelineExecutorFactory for an EmbeddedExecutor that returns a WebSubmissionJobClient.
WebSubmissionExecutorFactory(Collection<JobID>, DispatcherGateway) - Constructor for class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorFactory: Creates an WebSubmissionExecutorFactory.
WebSubmissionExecutorServiceLoader - Class in org.apache.flink.client.deployment.application.executors: A PipelineExecutorServiceLoader that always returns an WebSubmissionExecutorFactory.
WebSubmissionExecutorServiceLoader(Collection<JobID>, DispatcherGateway) - Constructor for class org.apache.flink.client.deployment.application.executors.WebSubmissionExecutorServiceLoader: Creates an WebSubmissionExecutorServiceLoader.
WebSubmissionJobClient - Class in org.apache.flink.client.deployment.application: A JobClient that only allows asking for the job id of the job it is attached to.
WebSubmissionJobClient(JobID) - Constructor for class org.apache.flink.client.deployment.application.WebSubmissionJobClient

Y

YARN_DETACHED_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser: Deprecated.
use non-prefixed variant CliFrontendParser.DETACHED_OPTION for both YARN and non-YARN deployments

Z

zookeeperNamespaceOption - Variable in class org.apache.flink.client.cli.AbstractCustomCommandLine

A B C D E F G H I J K L M N O P R S T U V W Y Z