Index (flink-clients 1.10.0 API)

A B C D E F G H I 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(Configuration) - Constructor for class org.apache.flink.client.cli.AbstractCustomCommandLine
AbstractJobClusterExecutor<ClusterID,ClientFactory extends ClusterClientFactory<ClusterID>> - Class in org.apache.flink.client.deployment.executors: An abstract PipelineExecutor used to execute pipelines on dedicated (per-job) clusters.
AbstractJobClusterExecutor(ClientFactory) - Constructor for class org.apache.flink.client.deployment.executors.AbstractJobClusterExecutor
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.ExecutorCLI
ADDRESS_OPTION - Static variable in class org.apache.flink.client.cli.CliFrontendParser
addressOption - Variable in class org.apache.flink.client.cli.AbstractCustomCommandLine
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.ExecutorCLI
applyCommandLineOptionsToConfiguration(CommandLine) - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
applyCommandLineOptionsToConfiguration(CommandLine) - Method in interface org.apache.flink.client.cli.CustomCommandLine: Override configuration settings by specified command line options.
applyCommandLineOptionsToConfiguration(CommandLine) - Method in class org.apache.flink.client.cli.ExecutorCLI
applyToConfiguration(Configuration) - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor

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.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) - Method in interface org.apache.flink.client.program.ClusterClient: Cancels a job identified by the job id and triggers a savepoint.
cancelWithSavepoint(JobID, String) - Method in class org.apache.flink.client.program.MiniClusterClient
cancelWithSavepoint(JobID, String) - 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
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
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.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) - 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
configuration - Variable in class org.apache.flink.client.cli.AbstractCustomCommandLine
ContextEnvironment - Class in org.apache.flink.client.program: Execution Environment for remote execution with the Client.
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(PipelineExecutorServiceLoader, Configuration, ClassLoader) - Constructor for class org.apache.flink.client.program.ContextEnvironmentFactory
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
createExecutionEnvironment() - Method in class org.apache.flink.client.program.ContextEnvironmentFactory
createJobGraph(PackagedProgram, Configuration, int, JobID, boolean) - Static method in class 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 class org.apache.flink.client.program.PackagedProgramUtils: Creates a JobGraph with a random JobID from the given PackagedProgram.
createSavepointRestoreSettings(CommandLine) - Static method in class org.apache.flink.client.cli.CliFrontendParser
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(Configuration) - 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
deleteExtractedLibraries() - Method in class org.apache.flink.client.program.PackagedProgram: Deletes all temporary files created for contained packaged libraries.
deployJobCluster(ClusterSpecification, JobGraph, boolean) - Method in interface org.apache.flink.client.deployment.ClusterDescriptor: Deploys a per-job cluster with the given job on the cluster.
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
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

E

execute(Pipeline, Configuration) - Method in class org.apache.flink.client.deployment.executors.AbstractJobClusterExecutor
execute(Pipeline, Configuration) - Method in class org.apache.flink.client.deployment.executors.AbstractSessionClusterExecutor
execute(Pipeline, Configuration) - Method in class org.apache.flink.client.deployment.executors.LocalExecutor
execute(String) - Method in class org.apache.flink.client.program.ContextEnvironment
executeAsync(String) - Method in class org.apache.flink.client.program.ContextEnvironment
executeAsync(String) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
executeProgram(Configuration, PackagedProgram) - Method in class org.apache.flink.client.cli.CliFrontend
executeProgram(PipelineExecutorServiceLoader, Configuration, PackagedProgram) - 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.
ExecutorCLI - 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.
ExecutorCLI(Configuration) - Constructor for class org.apache.flink.client.cli.ExecutorCLI
ExecutorUtils - Class in org.apache.flink.client.deployment.executors: Utility class with method related to job execution.
ExecutorUtils() - Constructor for class org.apache.flink.client.deployment.executors.ExecutorUtils
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.

F

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.
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.program.rest.RestClusterClientConfiguration
fromProgramOptions(ProgramOptions, List<URL>) - 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

getAccumulators(ClassLoader) - 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
getActiveCustomCommandLine(CommandLine) - Method in class org.apache.flink.client.cli.CliFrontend: Gets the custom command-line for the arguments.
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
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
getConfiguration() - Method in class org.apache.flink.client.cli.AbstractCustomCommandLine
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.executors.LocalExecutorFactory
getExecutor(Configuration) - Method in class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
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
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.ExecutorCLI
getInstance() - Static method in class org.apache.flink.client.deployment.StandaloneClusterId
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
getJobDetails(JobID) - Method in class org.apache.flink.client.program.rest.RestClusterClient: Requests the job details.
getJobExecutionResult(ClassLoader) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
getJobGraph(Pipeline, Configuration) - Static method in class org.apache.flink.client.deployment.executors.ExecutorUtils: Creates the JobGraph corresponding to the provided Pipeline.
getJobGraph(Pipeline, Configuration, int) - Static method in class org.apache.flink.client.FlinkPipelineTranslationUtil: Transmogrifies the given Pipeline to a JobGraph.
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.
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.executors.LocalExecutorFactory
getName() - Method in class org.apache.flink.client.deployment.executors.RemoteExecutorFactory
getParallelism() - Method in class org.apache.flink.client.cli.ExecutionConfigAccessor
getParallelism() - Method in class org.apache.flink.client.cli.ProgramOptions
getPipeline(PackagedProgram, boolean) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment: Retrieves the JobGraph from a PackagedProgram.
getPipelineFromProgram(PackagedProgram, int, boolean) - Static method in class org.apache.flink.client.program.PackagedProgramUtils
getProgramArgs() - Method in class org.apache.flink.client.cli.ProgramOptions
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
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.
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.ExecutorCLI
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() - Method in class org.apache.flink.client.cli.ProgramOptions: Indicates whether the job is a Python job.
isPython(String) - Static method in class org.apache.flink.client.program.PackagedProgramUtils
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

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.
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.
LocalExecutor() - Constructor for class org.apache.flink.client.deployment.executors.LocalExecutor
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.

N

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() - 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.
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.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.
PackagedProgramUtils - Class 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
parseCommandLineOptions(String[], boolean) - Method in interface org.apache.flink.client.cli.CustomCommandLine
parseParameters(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Parses the command line arguments and starts the requested action.
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
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() - Constructor for error org.apache.flink.client.program.OptimizerPlanEnvironment.ProgramAbortException
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
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.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
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.
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, ClientHighAvailabilityServices) - 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(String[]) - Method in class org.apache.flink.client.cli.CliFrontend: Executions the run action.

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
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
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(ContextEnvironmentFactory) - Static method in class org.apache.flink.client.program.ContextEnvironment
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
setPipeline(Pipeline) - Method in class org.apache.flink.client.program.OptimizerPlanEnvironment
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_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) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
stopWithSavepoint(JobID, boolean, String) - 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) - Method in class org.apache.flink.client.program.MiniClusterClient
stopWithSavepoint(JobID, boolean, String) - Method in class org.apache.flink.client.program.rest.RestClusterClient
submitJob(ClusterClient<?>, JobGraph) - Static method in enum org.apache.flink.client.ClientUtils
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) - Method in class org.apache.flink.client.program.rest.RestClusterClient
submitJobAndWaitForResult(ClusterClient<?>, JobGraph, ClassLoader) - Static method in enum org.apache.flink.client.ClientUtils

T

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
translateToJSONExecutionPlan(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
triggerSavepoint(String) - Method in class org.apache.flink.client.deployment.ClusterClientJobClientAdapter
triggerSavepoint(JobID, String) - Method in interface org.apache.flink.client.program.ClusterClient: Triggers a savepoint for the job identified by the job id.
triggerSavepoint(JobID, String) - Method in class org.apache.flink.client.program.MiniClusterClient
triggerSavepoint(JobID, String) - Method in class org.apache.flink.client.program.rest.RestClusterClient

U

unsetContext() - Static method in class org.apache.flink.client.program.ContextEnvironment

V

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.
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.

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.

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 K L M N O P R S T U V W Y Z