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:
  • 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. For CDC reads, this also includes the primary key and watermark columns, even when they are not requested.
    • getRequestedSchema

      public org.apache.iceberg.Schema getRequestedSchema()
      Returns the Schema of the columns selected by 'keep' or 'drop'.
    • 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.
    • recordIdSchema

      public org.apache.iceberg.Schema recordIdSchema()
    • rowIdBeamSchema

      public Schema rowIdBeamSchema()
    • recordIdComparator

      public Comparator<org.apache.iceberg.StructLike> recordIdComparator()
    • getEvaluator

      @Pure public @Nullable org.apache.iceberg.expressions.Evaluator getEvaluator(org.apache.iceberg.Schema requiredSchema)
    • 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()
    • getUpdateCompatibilityVersion

      @Pure public abstract @Nullable String getUpdateCompatibilityVersion()
    • 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()
    • getWatermarkColumn

      @Pure public abstract @Nullable String getWatermarkColumn()
    • getWatermarkColumnTimeUnit

      @Pure public abstract @Nullable String getWatermarkColumnTimeUnit()
    • getMetadataColumns

      @Pure public abstract List<String> getMetadataColumns()
    • builder

      @Pure public static IcebergScanConfig.Builder builder()