Package org.apache.flink.runtime.client

Enum ClientUtils

java.lang.Object

java.lang.Enum<ClientUtils>

org.apache.flink.runtime.client.ClientUtils

All Implemented Interfaces:

Serializable, Comparable<ClientUtils>

public enum ClientUtils
extends Enum<ClientUtils>

Contains utility methods for clients.

Method Summary

Modifier and Type	Method	Description
static void	extractAndUploadExecutionPlanFiles(ExecutionPlan executionPlan, org.apache.flink.util.function.SupplierWithException<BlobClient,IOException> clientSupplier)	Extracts all files required for the execution from the given ExecutionPlan and uploads them using the BlobClient from the given Supplier.
static void	uploadExecutionPlanFiles(ExecutionPlan executionPlan, Collection<org.apache.flink.core.fs.Path> userJars, Collection<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.core.fs.Path>> userArtifacts, org.apache.flink.util.function.SupplierWithException<BlobClient,IOException> clientSupplier)	Uploads the given jars and artifacts required for the execution of the given ExecutionPlan using the BlobClient from the given Supplier.
static ClientUtils	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ClientUtils[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static ClientUtils[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (ClientUtils c : ClientUtils.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static ClientUtils valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

extractAndUploadExecutionPlanFiles

public static void extractAndUploadExecutionPlanFiles(ExecutionPlan executionPlan,
                                                      org.apache.flink.util.function.SupplierWithException<BlobClient,IOException> clientSupplier)
                                               throws org.apache.flink.util.FlinkException

Extracts all files required for the execution from the given ExecutionPlan and uploads them using the BlobClient from the given Supplier.

Parameters:

executionPlan - executionPlan requiring files

clientSupplier - supplier of blob client to upload files with

Throws:

org.apache.flink.util.FlinkException - if the upload fails

uploadExecutionPlanFiles

public static void uploadExecutionPlanFiles(ExecutionPlan executionPlan,
                                            Collection<org.apache.flink.core.fs.Path> userJars,
                                            Collection<org.apache.flink.api.java.tuple.Tuple2<String,org.apache.flink.core.fs.Path>> userArtifacts,
                                            org.apache.flink.util.function.SupplierWithException<BlobClient,IOException> clientSupplier)
                                     throws org.apache.flink.util.FlinkException

Uploads the given jars and artifacts required for the execution of the given ExecutionPlan using the BlobClient from the given Supplier.

Parameters:

executionPlan - executionPlan requiring files

userJars - jars to upload

userArtifacts - artifacts to upload

clientSupplier - supplier of blob client to upload files with

Throws:

org.apache.flink.util.FlinkException - if the upload fails