Interface DiscoveryConfig
@Immutable
public interface DiscoveryConfig
A container for the configuration parameters of an Iceberg
discovery
.-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic interface
The interface for constructing aDiscoveryConfig
. -
Method Summary
Modifier and TypeMethodDescriptionstatic @NotNull DiscoveryConfig.Builder
builder()
@NotNull IcebergEndpoint
endpoint()
Optional; When supplied, this will be the namespace provided back in theDiscoveryResult
@NotNull Optional<TableDefinition>
Optional; A referenceTableDefinition
that the discovered table must be compatible with.@NotNull OptionalLong
The Snapshot ID to use when discovering the table from the catalog.@NotNull String
Optional; When supplied, this will be the table name provided back in theDiscoveryResult
.
-
Method Details
-
tableIdentifier
- Returns:
- The Iceberg Table identifier.
-
snapshotId
The Snapshot ID to use when discovering the table from the catalog.- Returns:
- the snapshot id.
-
endpoint
- Returns:
- The endpoint for discovery.
-
namespace
Optional; When supplied, this will be the namespace provided back in theDiscoveryResult
- Returns:
- the user supplied namespace.
-
tableName
Optional; When supplied, this will be the table name provided back in theDiscoveryResult
.- Returns:
- the user supplied table name
-
referenceDefinition
Optional; A referenceTableDefinition
that the discovered table must be compatible with.- Returns:
- the user supplied reference
TableDefinition
-
builder
- Returns:
- a new
DiscoveryConfig.Builder
-