Package io.deephaven.enterprise.iceberg.discovery

Interface DiscoveryConfig.Builder

Enclosing interface:

DiscoveryConfig

public static interface DiscoveryConfig.Builder

The interface for constructing a DiscoveryConfig.

Method Summary

Modifier and Type	Method	Description
@NotNull DiscoveryConfig	build()	Construct a new DiscoveryConfig from the state in this DiscoveryConfig.Builder.
@NotNull DiscoveryConfig.Builder	endpoint(@NotNull IcebergEndpoint endpoint)	Set the IcebergEndpoint.
@NotNull DiscoveryConfig.Builder	namespace(@NotNull String namespace)	An optional user specified namespace.
@NotNull DiscoveryConfig.Builder	referenceDefinition(@NotNull TableDefinition reference)	An optional user specified reference TableDefinition.
@NotNull DiscoveryConfig.Builder	snapshotId(@org.jetbrains.annotations.NotNull long snapshotId)	Set the snapshot id to use for fetching the Iceberg table.
@NotNull DiscoveryConfig.Builder	tableIdentifier(@NotNull String tableIdentifier)	Set the Iceberg table identifier for discovery.
@NotNull DiscoveryConfig.Builder	tableName(@NotNull String tableName)	An optional user specified table name.

Method Details

tableIdentifier

@NotNull
@NotNull DiscoveryConfig.Builder tableIdentifier(@NotNull
 @NotNull String tableIdentifier)

Set the Iceberg table identifier for discovery.

Parameters:

tableIdentifier - the table identifier.

Returns:

this DiscoveryConfig.Builder

snapshotId

@NotNull
@NotNull DiscoveryConfig.Builder snapshotId(@NotNull
 @org.jetbrains.annotations.NotNull long snapshotId)

Set the snapshot id to use for fetching the Iceberg table.

Parameters:

snapshotId - the snapshot id.

Returns:

this DiscoveryConfig.Builder

endpoint

@NotNull
@NotNull DiscoveryConfig.Builder endpoint(@NotNull
 @NotNull IcebergEndpoint endpoint)

Set the IcebergEndpoint. Users may supply a IcebergEndpoint.Named if the schema is going to be deployed with an endpoint reference.

Parameters:

endpoint - the endpoint for discovery

Returns:

this DiscoveryConfig.Builder

namespace

@NotNull
@NotNull DiscoveryConfig.Builder namespace(@NotNull
 @NotNull String namespace)

An optional user specified namespace. If not set, the namespace is derived from the DiscoveryConfig.tableIdentifier().

Parameters:

namespace - the namespace.

Returns:

this DiscoveryConfig.Builder

tableName

@NotNull
@NotNull DiscoveryConfig.Builder tableName(@NotNull
 @NotNull String tableName)

An optional user specified table name. If not set, the table name is derived from the DiscoveryConfig.tableIdentifier().

Parameters:

tableName - the table name.

Returns:

this DiscoveryConfig.Builder

referenceDefinition

@NotNull
@NotNull DiscoveryConfig.Builder referenceDefinition(@NotNull
 @NotNull TableDefinition reference)

An optional user specified reference TableDefinition. The discovery process will guarantee that the result is compatible with this definition.

Parameters:

reference - the reference definition.

Returns:

this DiscoveryConfig.Builder

build

@NotNull
@NotNull DiscoveryConfig build()

Construct a new DiscoveryConfig from the state in this DiscoveryConfig.Builder.

Returns:

a new DiscoveryConfig