Package org.apache.spark.sql.connector.read

Enum Class SampleMethod

Object

Enum<SampleMethod>

org.apache.spark.sql.connector.read.SampleMethod

All Implemented Interfaces:

Serializable, Comparable<SampleMethod>, Constable

@Evolving
public enum SampleMethod
extends Enum<SampleMethod>

The sampling method for TABLESAMPLE.

Since:

4.2.0

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
BERNOULLI	Row-level sampling (BERNOULLI).
SYSTEM	Block-level sampling (SYSTEM).

Method Summary

Modifier and Type	Method	Description
static SampleMethod	valueOf(String name)	Returns the enum constant of this class with the specified name.
static SampleMethod[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

BERNOULLI

public static final SampleMethod BERNOULLI

Row-level sampling (BERNOULLI). Each row is independently selected.

SYSTEM

public static final SampleMethod SYSTEM

Block-level sampling (SYSTEM). Entire partitions/splits are included or skipped.

Method Details

values

public static SampleMethod[] 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 SampleMethod 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