Package org.apache.beam.sdk.io.iceberg

Class IcebergScanConfig

java.lang.Object

org.apache.beam.sdk.io.iceberg.IcebergScanConfig

All Implemented Interfaces:

Serializable

public abstract class IcebergScanConfig
extends Object
implements Serializable

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	IcebergScanConfig.Builder
static enum	IcebergScanConfig.ScanType

Constructor Summary

Constructors

Constructor	Description
IcebergScanConfig()

Method Summary

Modifier and Type	Method	Description
static IcebergScanConfig.Builder	builder()
abstract @Nullable String	getBranch()
abstract @Nullable Boolean	getCaseSensitive()
abstract IcebergCatalogConfig	getCatalogConfig()
abstract @Nullable List<String>	getDropFields()
@Nullable org.apache.iceberg.expressions.Evaluator	getEvaluator()
@Nullable org.apache.iceberg.expressions.Expression	getFilter()
abstract @Nullable String	getFilterString()
abstract @Nullable Long	getFromSnapshotExclusive()
abstract @Nullable Long	getFromSnapshotInclusive()
abstract @Nullable String	getFromSnapshotRefExclusive()
abstract @Nullable String	getFromSnapshotRefInclusive()
abstract @Nullable Long	getFromTimestamp()
abstract @Nullable List<String>	getKeepFields()
abstract org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableMap<String,String>	getOptions()
abstract @Nullable Duration	getPollInterval()
org.apache.iceberg.Schema	getProjectedSchema()	Returns the projected Schema after applying column pruning.
org.apache.iceberg.Schema	getRequiredSchema()	Returns a Schema that includes all the fields required for a successful read.
abstract IcebergScanConfig.ScanType	getScanType()
abstract Schema	getSchema()
abstract @Nullable Long	getSnapshot()
abstract @Nullable IcebergIO.ReadRows.StartingStrategy	getStartingStrategy()
abstract @Nullable Boolean	getStreaming()
org.apache.iceberg.Table	getTable()
abstract String	getTableIdentifier()
abstract @Nullable String	getTag()
abstract @Nullable Long	getTimestamp()
abstract @Nullable Long	getToSnapshot()
abstract @Nullable String	getToSnapshotRef()
abstract @Nullable Long	getToTimestamp()
abstract boolean	getUseCdc()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

IcebergScanConfig

public IcebergScanConfig()

Method Details

getScanType

@Pure
public abstract IcebergScanConfig.ScanType getScanType()

getCatalogConfig

@Pure
public abstract IcebergCatalogConfig getCatalogConfig()

getTableIdentifier

@Pure
public abstract String getTableIdentifier()

getTable

@Pure
public org.apache.iceberg.Table getTable()

getSchema

@Pure
public abstract Schema getSchema()

getProjectedSchema

public org.apache.iceberg.Schema getProjectedSchema()

Returns the projected Schema after applying column pruning.

getRequiredSchema

public org.apache.iceberg.Schema getRequiredSchema()

Returns a Schema that includes all the fields required for a successful read. This includes explicitly selected fields and fields referenced in the filter statement.

getEvaluator

@Pure
public @Nullable org.apache.iceberg.expressions.Evaluator getEvaluator()

getFilter

@Pure
public @Nullable org.apache.iceberg.expressions.Expression getFilter()

getFilterString

@Pure
public abstract @Nullable String getFilterString()

getCaseSensitive

@Pure
public abstract @Nullable Boolean getCaseSensitive()

getOptions

@Pure
public abstract org.apache.beam.vendor.guava.v32_1_2_jre.com.google.common.collect.ImmutableMap<String,String> getOptions()

getSnapshot

@Pure
public abstract @Nullable Long getSnapshot()

getTimestamp

@Pure
public abstract @Nullable Long getTimestamp()

getFromSnapshotInclusive

@Pure
public abstract @Nullable Long getFromSnapshotInclusive()

getFromSnapshotRefInclusive

@Pure
public abstract @Nullable String getFromSnapshotRefInclusive()

getFromSnapshotExclusive

@Pure
public abstract @Nullable Long getFromSnapshotExclusive()

getFromSnapshotRefExclusive

@Pure
public abstract @Nullable String getFromSnapshotRefExclusive()

getToSnapshot

@Pure
public abstract @Nullable Long getToSnapshot()

getToSnapshotRef

@Pure
public abstract @Nullable String getToSnapshotRef()

getFromTimestamp

@Pure
public abstract @Nullable Long getFromTimestamp()

getToTimestamp

@Pure
public abstract @Nullable Long getToTimestamp()

getStartingStrategy

@Pure
public abstract @Nullable IcebergIO.ReadRows.StartingStrategy getStartingStrategy()

getUseCdc

@Pure
public abstract boolean getUseCdc()

getStreaming

@Pure
public abstract @Nullable Boolean getStreaming()

getPollInterval

@Pure
public abstract @Nullable Duration getPollInterval()

getTag

@Pure
public abstract @Nullable String getTag()

getBranch

@Pure
public abstract @Nullable String getBranch()

getKeepFields

@Pure
public abstract @Nullable List<String> getKeepFields()

getDropFields

@Pure
public abstract @Nullable List<String> getDropFields()

builder

@Pure
public static IcebergScanConfig.Builder builder()