Package org.apache.flink.runtime.webmonitor

Enum WebMonitorExtension.EmptyWebMonitorExtension

java.lang.Object

java.lang.Enum<WebMonitorExtension.EmptyWebMonitorExtension>

org.apache.flink.runtime.webmonitor.WebMonitorExtension.EmptyWebMonitorExtension

All Implemented Interfaces:

Serializable, AutoCloseable, Comparable<WebMonitorExtension.EmptyWebMonitorExtension>, WebMonitorExtension, AutoCloseableAsync

Enclosing interface:

WebMonitorExtension

public static enum WebMonitorExtension.EmptyWebMonitorExtension
extends Enum<WebMonitorExtension.EmptyWebMonitorExtension>
implements WebMonitorExtension

Empty web monitor extension which can be used as a null object.

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.flink.runtime.webmonitor.WebMonitorExtension

WebMonitorExtension.EmptyWebMonitorExtension

Enum Constant Summary

Enum Constants

Enum Constant	Description
INSTANCE

Method Summary

Modifier and Type	Method	Description
CompletableFuture<Void>	closeAsync()	Trigger the closing of the resource and return the corresponding close future.
Collection<Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>>	getHandlers()	Gets the collection of extension handlers to register at the WebMonitorEndpoint.
static WebMonitorExtension.EmptyWebMonitorExtension	valueOf(String name)	Returns the enum constant of this type with the specified name.
static WebMonitorExtension.EmptyWebMonitorExtension[]	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

Methods inherited from interface org.apache.flink.util.AutoCloseableAsync

close

Enum Constant Detail

INSTANCE

public static final WebMonitorExtension.EmptyWebMonitorExtension INSTANCE

Method Detail

values

public static WebMonitorExtension.EmptyWebMonitorExtension[] 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 (WebMonitorExtension.EmptyWebMonitorExtension c : WebMonitorExtension.EmptyWebMonitorExtension.values())
    System.out.println(c);

Returns:

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

valueOf

public static WebMonitorExtension.EmptyWebMonitorExtension 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

getHandlers

public Collection<Tuple2<RestHandlerSpecification,org.apache.flink.shaded.netty4.io.netty.channel.ChannelInboundHandler>> getHandlers()

Description copied from interface: WebMonitorExtension

Gets the collection of extension handlers to register at the WebMonitorEndpoint.

Specified by:

getHandlers in interface WebMonitorExtension

Returns:

Collection of handlers to register at the WebMonitorEndpoint.

closeAsync

public CompletableFuture<Void> closeAsync()

Description copied from interface: AutoCloseableAsync

Trigger the closing of the resource and return the corresponding close future.

Specified by:

closeAsync in interface AutoCloseableAsync

Returns:

Future which is completed once the resource has been closed