Package io.substrait.relation

Enum Class AbstractWriteRel.OutputMode

java.lang.Object

java.lang.Enum<AbstractWriteRel.OutputMode>

io.substrait.relation.AbstractWriteRel.OutputMode

All Implemented Interfaces:

Serializable, Comparable<AbstractWriteRel.OutputMode>, Constable

Enclosing class:

AbstractWriteRel

public static enum AbstractWriteRel.OutputMode
extends Enum<AbstractWriteRel.OutputMode>

Output behavior for write operations.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODIFIED_RECORDS	Only modified records are produced.
NO_OUTPUT	No rows are produced by the write.
UNSPECIFIED	Unspecified output.

Method Summary

Modifier and Type	Method	Description
static AbstractWriteRel.OutputMode	fromProto(WriteRel.OutputMode proto)	Maps a protobuf value to this enum.
WriteRel.OutputMode	toProto()	Converts this enum to its protobuf counterpart.
static AbstractWriteRel.OutputMode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static AbstractWriteRel.OutputMode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

UNSPECIFIED

public static final AbstractWriteRel.OutputMode UNSPECIFIED

Unspecified output.

NO_OUTPUT

public static final AbstractWriteRel.OutputMode NO_OUTPUT

No rows are produced by the write.

MODIFIED_RECORDS

public static final AbstractWriteRel.OutputMode MODIFIED_RECORDS

Only modified records are produced.

Method Details

values

public static AbstractWriteRel.OutputMode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static AbstractWriteRel.OutputMode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

toProto

public WriteRel.OutputMode toProto()

Converts this enum to its protobuf counterpart.

Returns:

protobuf enum value

fromProto

public static AbstractWriteRel.OutputMode fromProto(WriteRel.OutputMode proto)

Maps a protobuf value to this enum.

Parameters:

proto - protobuf enum value

Returns:

matching OutputMode

Throws:

IllegalArgumentException - if unknown