Index (flink-clients 1.2.0 API)

A B C D E F G H I J L M O P R S T U W

A

actorSystemLoader - Variable in class org.apache.flink.client.program.ClusterClient: The actor system used to communicate with the JobManager.
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
ADDRESS_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
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.DefaultCLI

B

buildProgram(ProgramOptions) - Method in class org.apache.flink.client.CliFrontend: Creates a Packaged program from the given command line options.
buildUserCodeClassLoader(List<URL>, List<URL>, ClassLoader) - Static method in class org.apache.flink.client.program.JobWithJars

C

cancel(String[]) - Method in class org.apache.flink.client.CliFrontend: Executes the CANCEL action.
cancel(JobID) - Method in class org.apache.flink.client.program.ClusterClient: Cancels a job identified by the job id.
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
checkJarFile(URL) - Static method in class org.apache.flink.client.program.JobWithJars
classpathsToAttach - Variable in class org.apache.flink.client.program.ContextEnvironment
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
client - Variable in class org.apache.flink.client.program.ContextEnvironment
ClientUtils - Class in org.apache.flink.client: A class that provides some utility methods
ClientUtils() - Constructor for class org.apache.flink.client.ClientUtils
CliFrontend - Class in org.apache.flink.client: Implementation of a simple command line frontend for executing programs.
CliFrontend() - Constructor for class org.apache.flink.client.CliFrontend
CliFrontend(String) - Constructor for class org.apache.flink.client.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
ClusterClient - Class in org.apache.flink.client.program: Encapsulates the functionality necessary to submit a program to a remote cluster.
ClusterClient(Configuration) - Constructor for class org.apache.flink.client.program.ClusterClient: Creates a instance that submits the programs to the JobManager defined in the configuration.
ClusterClient.LazyActorSystemLoader - Class in org.apache.flink.client.program
ClusterDescriptor<ClientType extends ClusterClient> - Interface in org.apache.flink.client.deployment: A descriptor to deploy a cluster (e.g.
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
ContextEnvironment - Class in org.apache.flink.client.program: Execution Environment for remote execution with the Client.
ContextEnvironment(ClusterClient, List<URL>, List<URL>, ClassLoader, SavepointRestoreSettings) - Constructor for class org.apache.flink.client.program.ContextEnvironment
ContextEnvironmentFactory - Class in org.apache.flink.client.program: The factory that instantiates the environment to be used when running jobs that are submitted through a pre-configured client connection.
ContextEnvironmentFactory(ClusterClient, List<URL>, List<URL>, ClassLoader, int, boolean, SavepointRestoreSettings) - Constructor for class org.apache.flink.client.program.ContextEnvironmentFactory
createClient(CommandLineOptions, PackagedProgram) - Method in class org.apache.flink.client.CliFrontend: Creates a ClusterClient object from the given command line options and other parameters.
createCluster(String, CommandLine, Configuration, List<URL>) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Creates the client for the cluster
createCluster(String, CommandLine, Configuration, List<URL>) - Method in class org.apache.flink.client.cli.DefaultCLI
createExecutionEnvironment() - Method in class org.apache.flink.client.program.ContextEnvironmentFactory
CustomCommandLine<ClusterType extends ClusterClient> - 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
deleteExtractedLibraries() - Method in class org.apache.flink.client.program.PackagedProgram: Deletes all temporary files created for contained packaged libraries.
deleteExtractedLibraries(List<File>) - Static method in class org.apache.flink.client.program.PackagedProgram
deploy() - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Triggers deployment of a cluster
deploy() - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
DETACHED_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
DetachedEnvironment - Class in org.apache.flink.client.program: Execution Environment for remote execution with the Client in detached mode.
DetachedEnvironment(ClusterClient, List<URL>, List<URL>, ClassLoader, SavepointRestoreSettings) - Constructor for class org.apache.flink.client.program.DetachedEnvironment
DetachedEnvironment.DetachedJobExecutionResult - Class in org.apache.flink.client.program

E

endSession(JobID) - Method in class org.apache.flink.client.LocalExecutor
endSession(JobID) - Method in class org.apache.flink.client.program.ClusterClient: Tells the JobManager to finish the session (job) defined by the given ID.
endSession(JobID) - Method in class org.apache.flink.client.RemoteExecutor
endSessions(List<JobID>) - Method in class org.apache.flink.client.program.ClusterClient: Tells the JobManager to finish the sessions (jobs) defined by the given IDs.
execute(Program, String...) - Static method in class org.apache.flink.client.LocalExecutor: Executes the given program.
execute(Plan) - Static method in class org.apache.flink.client.LocalExecutor: Executes the given dataflow plan.
execute(String) - Method in class org.apache.flink.client.program.ContextEnvironment
execute(String) - Method in class org.apache.flink.client.program.DetachedEnvironment
execute(String) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
execute(String) - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
executePlan(Plan) - Method in class org.apache.flink.client.LocalExecutor: Executes the given program on a local runtime and waits for the job to finish.
executePlan(Plan) - Method in class org.apache.flink.client.RemoteExecutor
executePlanWithJars(JobWithJars) - Method in class org.apache.flink.client.RemoteExecutor
executeProgram(PackagedProgram, ClusterClient, int) - Method in class org.apache.flink.client.CliFrontend
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.

F

finalizeCluster() - Method in class org.apache.flink.client.program.ClusterClient: Request the cluster to shut down or disconnect.
finalizeCluster() - Method in class org.apache.flink.client.program.StandaloneClusterClient
flinkConfig - Variable in class org.apache.flink.client.program.ClusterClient: Configuration of the client

G

get() - Method in class org.apache.flink.client.program.ClusterClient.LazyActorSystemLoader: Creates a new ActorSystem or returns an existing one.
getAccumulatorResult(String) - Method in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
getAccumulators(JobID) - Method in class 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.ClusterClient: Requests and returns the accumulators for the given job identifier.
getActiveCustomCommandLine(CommandLine) - Method in class org.apache.flink.client.CliFrontend: Gets the custom command-line for the arguments.
getAllAccumulatorResults() - Method in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
getAllLibraries() - Method in class org.apache.flink.client.program.PackagedProgram: Returns all provided libraries needed to run the program.
getArgs() - Method in class org.apache.flink.client.cli.CancelOptions
getArgs() - Method in class org.apache.flink.client.cli.SavepointOptions
getArgs() - Method in class org.apache.flink.client.cli.StopOptions
getArguments() - Method in class org.apache.flink.client.program.PackagedProgram
getClasspaths() - Method in class org.apache.flink.client.cli.ProgramOptions
getClasspaths() - Method in class org.apache.flink.client.program.ContextEnvironment
getClasspaths() - Method in class org.apache.flink.client.program.JobWithJars: Returns list of classpaths that need to be submitted with the plan.
getClasspaths() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the classpaths that are required by the program.
getClient() - Method in class org.apache.flink.client.program.ContextEnvironment
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
getClusterIdentifier() - Method in class org.apache.flink.client.program.ClusterClient: Returns a string representation of the cluster.
getClusterIdentifier() - Method in class org.apache.flink.client.program.StandaloneClusterClient
getClusterStatus() - Method in class org.apache.flink.client.program.ClusterClient: Returns the latest cluster status, with number of Taskmanagers and slots
getClusterStatus() - Method in class org.apache.flink.client.program.StandaloneClusterClient
getCommandLine() - Method in class org.apache.flink.client.cli.CommandLineOptions
getConfiguration() - Method in class org.apache.flink.client.CliFrontend: Getter which returns a copy of the associated configuration
getConfigurationDirectoryFromEnv() - Static method in class org.apache.flink.client.CliFrontend
getCustomCommandLineList() - Static method in class org.apache.flink.client.CliFrontend: Retrieves the loaded custom command-lines.
getDefaultParallelism() - Method in class org.apache.flink.client.RemoteExecutor: Gets the parallelism that will be used when neither the program does not define any parallelism at all.
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.ProgramOptions
getEntryPointClassName() - Method in class org.apache.flink.client.cli.ProgramOptions
getExecutionPlan() - Method in class org.apache.flink.client.program.ContextEnvironment
getExecutionPlan() - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
getExecutionPlan() - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
getFlinkConfiguration() - Method in class org.apache.flink.client.program.ClusterClient: Return the Flink configuration object
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
getIntCounterResult(String) - Method in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
getJarFilePath() - Method in class org.apache.flink.client.cli.ProgramOptions
getJarFilePath() - Method in class org.apache.flink.client.cli.SavepointOptions
getJarFiles() - Method in class org.apache.flink.client.program.JobWithJars: Returns list of jar files that need to be submitted with the plan.
getJars() - Method in class org.apache.flink.client.program.ContextEnvironment
getJobGraph(PackagedProgram, FlinkPlan, SavepointRestoreSettings) - Method in class org.apache.flink.client.program.ClusterClient
getJobID() - Method in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
getJobManagerAddress() - Method in class org.apache.flink.client.cli.CommandLineOptions
getJobManagerAddress() - Method in class org.apache.flink.client.program.ClusterClient: Gets the current JobManager address (may change in case of a HA setup).
getJobManagerGateway(CommandLineOptions) - Method in class org.apache.flink.client.CliFrontend: Retrieves the ActorGateway for the JobManager.
getJobManagerGateway() - Method in class org.apache.flink.client.program.ClusterClient: Returns the ActorGateway of the current job manager leader using the LeaderRetrievalService.
getLastEnvCreated() - Method in class org.apache.flink.client.program.ContextEnvironmentFactory
getMainClassName() - Method in class org.apache.flink.client.program.PackagedProgram
getMaxSlots() - Method in class org.apache.flink.client.program.ClusterClient: The client may define an upper limit on the number of slots to use
getMaxSlots() - Method in class org.apache.flink.client.program.StandaloneClusterClient
getNetRuntime() - Method in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
getNewMessages() - Method in class org.apache.flink.client.program.ClusterClient: May return new messages from the cluster.
getNewMessages() - Method in class org.apache.flink.client.program.StandaloneClusterClient
getOptimizedPlan(Optimizer, PackagedProgram, int) - Static method in class org.apache.flink.client.program.ClusterClient
getOptimizedPlan(Optimizer, Plan, int) - Static method in class org.apache.flink.client.program.ClusterClient
getOptimizedPlan(PackagedProgram) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
getOptimizedPlanAsJson(Optimizer, PackagedProgram, int) - Static method in class org.apache.flink.client.program.ClusterClient
getOptimizerPlanAsJSON(Plan) - Method in class org.apache.flink.client.LocalExecutor: Creates a JSON representation of the given dataflow's execution plan.
getOptimizerPlanAsJSON(Plan) - Method in class org.apache.flink.client.RemoteExecutor
getParallelism() - Method in class org.apache.flink.client.cli.ProgramOptions
getPlan() - Method in class org.apache.flink.client.program.JobWithJars: Returns the plan
getPlan() - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
getPlanAsJSON(Plan) - Static method in class org.apache.flink.client.LocalExecutor: Creates a JSON representation of the given dataflow plan.
getPlanWithJars() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the plan with all required jars.
getPlanWithoutJars() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the plan without the required jars when the files are already provided by the cluster.
getPreviewPlan() - Method in class org.apache.flink.client.program.PackagedProgram: Returns the analyzed plan without any optimizations.
getPrintStatusDuringExecution() - Method in class org.apache.flink.client.program.ClusterClient
getProgramArgs() - Method in class org.apache.flink.client.cli.ProgramOptions
getProgramSpecificOptions(Options) - Static method in class org.apache.flink.client.cli.CliFrontendParser
getRunning() - Method in class org.apache.flink.client.cli.ListOptions
getSavepointPath() - Method in class org.apache.flink.client.cli.SavepointOptions
getSavepointRestoreSettings() - Method in class org.apache.flink.client.cli.ProgramOptions
getSavepointRestoreSettings() - Method in class org.apache.flink.client.program.ContextEnvironment
getSavepointSettings() - Method in class org.apache.flink.client.program.PackagedProgram
getSavepointTargetDirectory() - Method in class org.apache.flink.client.cli.CancelOptions
getScheduled() - Method in class org.apache.flink.client.cli.ListOptions
getStdoutLogging() - Method in class org.apache.flink.client.cli.ProgramOptions
getTaskManagerNumSlots() - Method in class org.apache.flink.client.LocalExecutor
getUserCodeClassLoader() - Method in class org.apache.flink.client.program.ContextEnvironment
getUserCodeClassLoader() - Method in class org.apache.flink.client.program.JobWithJars: Gets the ClassLoader that must be used to load user code classes.
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 class org.apache.flink.client.program.ClusterClient: Returns an URL (as a string) to the JobManager web interface
getWebInterfaceURL() - Method in class org.apache.flink.client.program.StandaloneClusterClient

H

hasUserJarsInClassPath(List<URL>) - Method in class org.apache.flink.client.program.ClusterClient: Returns true if the client already has the user jar and providing it again would result in duplicate uploading of the jar.
hasUserJarsInClassPath(List<URL>) - Method in class org.apache.flink.client.program.StandaloneClusterClient

I

info(String[]) - Method in class org.apache.flink.client.CliFrontend: Executes the info action.
InfoOptions - Class in org.apache.flink.client.cli: Command line options for the INFO command
InfoOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.InfoOptions
INSTANCE - Static variable in class org.apache.flink.client.program.DetachedEnvironment.DetachedJobExecutionResult
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, Configuration) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Signals whether the custom command-line wants to execute or not
isActive(CommandLine, Configuration) - Method in class org.apache.flink.client.cli.DefaultCLI
isDefaultOverwriteFiles() - Method in class org.apache.flink.client.LocalExecutor
isDetached() - Method in class org.apache.flink.client.program.ClusterClient: A flag to indicate whether this clients submits jobs detached.
isDispose() - Method in class org.apache.flink.client.cli.SavepointOptions
isLoaded() - Method in class org.apache.flink.client.program.ClusterClient.LazyActorSystemLoader: Indicates whether the ActorSystem has already been instantiated.
isPrintHelp() - Method in class org.apache.flink.client.cli.CommandLineOptions
isRunning() - Method in class org.apache.flink.client.LocalExecutor
isRunning() - Method in class org.apache.flink.client.RemoteExecutor
isUsingInteractiveMode() - Method in class org.apache.flink.client.program.PackagedProgram
isUsingProgramEntryPoint() - Method in class org.apache.flink.client.program.PackagedProgram
isWithSavepoint() - Method in class org.apache.flink.client.cli.CancelOptions

J

jarFilesToAttach - Variable in class org.apache.flink.client.program.ContextEnvironment
JobWithJars - Class in org.apache.flink.client.program: A JobWithJars is a Flink dataflow plan, together with a bunch of JAR files that contain the classes of the functions and libraries necessary for the execution.
JobWithJars(Plan, List<URL>, List<URL>) - Constructor for class org.apache.flink.client.program.JobWithJars
JobWithJars(Plan, URL) - Constructor for class org.apache.flink.client.program.JobWithJars

L

list(String[]) - Method in class org.apache.flink.client.CliFrontend: Executes the list action.
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
LocalExecutor - Class in org.apache.flink.client: A PlanExecutor that runs Flink programs on a local embedded Flink runtime instance.
LocalExecutor() - Constructor for class org.apache.flink.client.LocalExecutor
LocalExecutor(Configuration) - Constructor for class org.apache.flink.client.LocalExecutor
logAndSysout(String) - Method in class org.apache.flink.client.program.ClusterClient: Logs and prints to sysout if printing to stdout is enabled.

M

main(String[]) - Static method in class org.apache.flink.client.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.

O

optimizerPlanAsJSON(Plan) - Static method in class org.apache.flink.client.LocalExecutor: Creates a JSON representation of the given dataflow's execution plan.
OptimizerPlanEnvironment - Class in org.apache.flink.client.program
OptimizerPlanEnvironment(Optimizer) - Constructor for class org.apache.flink.client.program.OptimizerPlanEnvironment
OptimizerPlanEnvironment.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.
OptimizerPlanEnvironment.ProgramAbortException() - Constructor for error org.apache.flink.client.program.OptimizerPlanEnvironment.ProgramAbortException
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.program - package org.apache.flink.client.program

P

PackagedProgram - Class in org.apache.flink.client.program: This class encapsulates represents a program, packaged in a jar file.
PackagedProgram(File, String...) - Constructor for class org.apache.flink.client.program.PackagedProgram: Creates an instance that wraps the plan defined in the jar file using the given argument.
PackagedProgram(File, List<URL>, String...) - Constructor for class org.apache.flink.client.program.PackagedProgram: Creates an instance that wraps the plan defined in the jar file using the given argument.
PackagedProgram(File, String, String...) - Constructor for class org.apache.flink.client.program.PackagedProgram: Creates an instance that wraps the plan defined in the jar file using the given arguments.
PackagedProgram(File, List<URL>, String, String...) - Constructor for class org.apache.flink.client.program.PackagedProgram: Creates an instance that wraps the plan defined in the jar file using the given arguments.
PARALLELISM_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
parseCancelCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseHostPortAddress(String) - Static method in class org.apache.flink.client.ClientUtils: Utility method that converts a string of the form "host:port" into an InetSocketAddress.
parseInfoCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseListCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseParameters(String[]) - Method in class org.apache.flink.client.CliFrontend: Parses the command line arguments and starts the requested action.
parseRunCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseSavepointCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
parseStopCommand(String[]) - Static method in class org.apache.flink.client.cli.CliFrontendParser
PreviewPlanEnvironment - Class in org.apache.flink.client.program: Environment to extract the pre-optimized plan.
PreviewPlanEnvironment() - Constructor for class org.apache.flink.client.program.PreviewPlanEnvironment
printHelp() - Static method in class org.apache.flink.client.cli.CliFrontendParser: Prints the help for the client.
printHelpForCancel() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForInfo() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForList() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForRun() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForSavepoint() - Static method in class org.apache.flink.client.cli.CliFrontendParser
printHelpForStop() - Static method in class org.apache.flink.client.cli.CliFrontendParser
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(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.
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() - 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
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.

R

RemoteExecutor - Class in org.apache.flink.client: The RemoteExecutor is a PlanExecutor that takes the program and ships it to a remote Flink cluster for execution.
RemoteExecutor(String, int) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, int, URL) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, URL) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, int, List<URL>) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, int, Configuration) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, int, Configuration, URL) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, Configuration, URL) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(String, int, Configuration, List<URL>, List<URL>) - Constructor for class org.apache.flink.client.RemoteExecutor
RemoteExecutor(InetSocketAddress, Configuration, List<URL>, List<URL>) - Constructor for class org.apache.flink.client.RemoteExecutor
retrieve(String) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Retrieves an existing Flink Cluster.
retrieve(String) - Method in class org.apache.flink.client.deployment.StandaloneClusterDescriptor
retrieveClient(CommandLineOptions) - Method in class org.apache.flink.client.CliFrontend: Updates the associated configuration with the given command line options
retrieveCluster(CommandLine, Configuration) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Retrieves a client for a running cluster
retrieveCluster(CommandLine, Configuration) - Method in class org.apache.flink.client.cli.DefaultCLI
retrieveJob(JobID) - Method in class org.apache.flink.client.program.ClusterClient: Reattaches to a running from from the supplied job id
run(String[]) - Method in class org.apache.flink.client.CliFrontend: Executions the run action.
run(PackagedProgram, int) - Method in class org.apache.flink.client.program.ClusterClient: General purpose method to run a user jar from the CliFrontend in either blocking or detached mode, depending on whether setDetached(true) or setDetached(false).
run(JobWithJars, int) - Method in class org.apache.flink.client.program.ClusterClient
run(JobWithJars, int, SavepointRestoreSettings) - Method in class org.apache.flink.client.program.ClusterClient: Runs a program on the Flink cluster to which this client is connected.
run(FlinkPlan, List<URL>, List<URL>, ClassLoader) - Method in class org.apache.flink.client.program.ClusterClient
run(FlinkPlan, List<URL>, List<URL>, ClassLoader, SavepointRestoreSettings) - Method in class org.apache.flink.client.program.ClusterClient
run(JobGraph, ClassLoader) - Method in class org.apache.flink.client.program.ClusterClient: Submits a JobGraph blocking.
runDetached(JobGraph, ClassLoader) - Method in class org.apache.flink.client.program.ClusterClient: Submits a JobGraph detached.
RunOptions - Class in org.apache.flink.client.cli: Command line options for the RUN command.
RunOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.RunOptions

S

savepoint(String[]) - Method in class org.apache.flink.client.CliFrontend: Executes the SAVEPOINT action.
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
savepointSettings - Variable in class org.apache.flink.client.program.ContextEnvironment
setAsContext() - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
setDefaultOverwriteFiles(boolean) - Method in class org.apache.flink.client.LocalExecutor
setDefaultParallelism(int) - Method in class org.apache.flink.client.RemoteExecutor: Sets the parallelism that will be used when neither the program does not define any parallelism at all.
setDetached(boolean) - Method in class org.apache.flink.client.program.ClusterClient: Set the mode of this client (detached or blocking job execution).
setDetachedPlan(FlinkPlan) - Method in class org.apache.flink.client.program.DetachedEnvironment
setJobManagerAddressInConfig(Configuration, InetSocketAddress) - Static method in class org.apache.flink.client.CliFrontend: Writes the given job manager address to the associated configuration object
setPlan(FlinkPlan) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
setPreview(String) - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
setPrintStatusDuringExecution(boolean) - Method in class org.apache.flink.client.program.ClusterClient: Configures whether the client should print progress updates during the execution to System.out.
setSavepointRestoreSettings(SavepointRestoreSettings) - Method in class org.apache.flink.client.program.PackagedProgram
setTaskManagerNumSlots(int) - Method in class org.apache.flink.client.LocalExecutor
shutdown() - Method in class org.apache.flink.client.program.ClusterClient.LazyActorSystemLoader
shutdown() - Method in class org.apache.flink.client.program.ClusterClient: Shuts down the client.
StandaloneClusterClient - Class in org.apache.flink.client.program: Cluster client for communication with an standalone (on-premise) cluster or an existing cluster that has been brought up independently of a specific job.
StandaloneClusterClient(Configuration) - Constructor for class org.apache.flink.client.program.StandaloneClusterClient
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
start() - Method in class org.apache.flink.client.LocalExecutor
start() - Method in class org.apache.flink.client.RemoteExecutor
startNewSession() - Method in class org.apache.flink.client.program.ContextEnvironment
startNewSession() - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
startNewSession() - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
stop(String[]) - Method in class org.apache.flink.client.CliFrontend: Executes the STOP action.
stop() - Method in class org.apache.flink.client.LocalExecutor
stop(JobID) - Method in class org.apache.flink.client.program.ClusterClient: Stops a program on Flink cluster whose job-manager is configured in this client's configuration.
stop() - Method in class org.apache.flink.client.RemoteExecutor
StopOptions - Class in org.apache.flink.client.cli: Command line options for the STOP command
StopOptions(CommandLine) - Constructor for class org.apache.flink.client.cli.StopOptions
submitJob(JobGraph, ClassLoader) - Method in class org.apache.flink.client.program.ClusterClient: Calls the subclasses' submitJob method.
submitJob(JobGraph, ClassLoader) - Method in class org.apache.flink.client.program.StandaloneClusterClient

T

timeout - Variable in class org.apache.flink.client.program.ClusterClient: Timeout for futures
toString() - Method in class org.apache.flink.client.program.ContextEnvironment

U

unsetAsContext() - Method in class org.apache.flink.client.program.PreviewPlanEnvironment
userCodeClassLoader - Variable in class org.apache.flink.client.program.ContextEnvironment

W

waitForClusterToBeReady() - Method in class org.apache.flink.client.program.ClusterClient: Blocks until the client has determined that the cluster is ready for Job submission.
waitForClusterToBeReady() - Method in class org.apache.flink.client.program.StandaloneClusterClient

A B C D E F G H I J L M O P R S T U W