Package io.deephaven.enterprise.iceberg

Interface IcebergEndpoint.Builder

Enclosing class:

IcebergEndpoint

public static interface IcebergEndpoint.Builder

A Builder object for construction of a IcebergEndpoint.

Method Summary

Modifier and Type	Method	Description
@NotNull IcebergEndpoint	build()	Construct an anonymous IcebergEndpoint from the builder state.
@NotNull IcebergEndpoint.Named	build(@NotNull String name)	Construct a named IcebergEndpoint from the builder state.
@NotNull IcebergEndpoint.Builder	catalogName(@NotNull String catalogName)	Optional.
@NotNull IcebergEndpoint.Builder	catalogType(@NotNull String type)	Set the Iceberg catalog type.
@NotNull IcebergEndpoint.Builder	catalogUri(@NotNull String uri)	Set the URI for accessing the catalog.
@NotNull IcebergEndpoint.Builder	dataInstructions(@NotNull Object instructions)	Set the opaque data instructions for Deephaven to use when fetching table data, for example an S3Instructions instance could be provided.
default @NotNull IcebergEndpoint.Builder	putHadoopOptions(@NotNull String... options)	Add the passed hadoop options to the builder.
@NotNull IcebergEndpoint.Builder	putHadoopOptions(@NotNull Map<String,? extends String> opts)	Add the passed hadoop options to the builder.
default @NotNull IcebergEndpoint.Builder	putProperties(@NotNull String... props)	Add the passed properties to the builder.
@NotNull IcebergEndpoint.Builder	putProperties(@NotNull Map<String,? extends String> props)	Add the passed properties to the builder.
default @NotNull IcebergEndpoint.Builder	putSecrets(@NotNull String... secrets)	Add the passed secrets to the builder.
@NotNull IcebergEndpoint.Builder	putSecrets(@NotNull Map<String,? extends String> secrets)	Add the passed secrets to the builder.
@NotNull IcebergEndpoint.Builder	warehouseUri(@NotNull String uri)	Set the URI for accessing table data.

Method Details

catalogType

@NotNull
@NotNull IcebergEndpoint.Builder catalogType(@NotNull
 @NotNull String type)

Set the Iceberg catalog type. Choices include "hive", "hadoop", "rest", "glue", "nessie", "jdbc".

Parameters:

type - the catalog type.

Returns:

this IcebergEndpoint.Builder

catalogUri

@NotNull
@NotNull IcebergEndpoint.Builder catalogUri(@NotNull
 @NotNull String uri)

Set the URI for accessing the catalog.

Parameters:

uri - the catalog uri

Returns:

this IcebergEndpoint.Builder

catalogName

@NotNull
@NotNull IcebergEndpoint.Builder catalogName(@NotNull
 @NotNull String catalogName)

Optional. Set the name of the catalog. This is useful for certain catalog implementations that use the catalog name as part of the connection, for example JDBC.

Parameters:

catalogName - the name of the catalog.

Returns:

this IcebergEndpoint.Builder

warehouseUri

@NotNull
@NotNull IcebergEndpoint.Builder warehouseUri(@NotNull
 @NotNull String uri)

Set the URI for accessing table data.

Parameters:

uri - the warehouse uri

Returns:

this IcebergEndpoint.Builder

putProperties

@FinalDefault
@NotNull
default @NotNull IcebergEndpoint.Builder putProperties(@NotNull
 @NotNull String... props)

Add the passed properties to the builder. The parameters are expected to be pairs of (Key, Value) Strings.

Parameters:

props - the properties to add.

Returns:

this IcebergEndpoint.Builder

putProperties

@NotNull
@NotNull IcebergEndpoint.Builder putProperties(@NotNull
 @NotNull Map<String,? extends String> props)

Add the passed properties to the builder.

Parameters:

props - the properties

Returns:

this IcebergEndpoint.Builder

putSecrets

@FinalDefault
@NotNull
default @NotNull IcebergEndpoint.Builder putSecrets(@NotNull
 @NotNull String... secrets)

Add the passed secrets to the builder. Secrets should be provided by key and name, not actual secret values. Actual values will be determined at usage time using the SecretsService The secrets are expected to be pairs of (Key, Value) Strings.

Parameters:

secrets - the secrets

Returns:

this IcebergEndpoint.Builder

putSecrets

@NotNull
@NotNull IcebergEndpoint.Builder putSecrets(@NotNull
 @NotNull Map<String,? extends String> secrets)

Add the passed secrets to the builder. Secrets should be provided by key and name, not actual secret values. Actual values will be determined at usage time using the SecretsService

Parameters:

secrets - the secrets.

Returns:

this IcebergEndpoint.Builder

putHadoopOptions

@FinalDefault
@NotNull
default @NotNull IcebergEndpoint.Builder putHadoopOptions(@NotNull
 @NotNull String... options)

Add the passed hadoop options to the builder. The options are expected to be pairs of (Key, Value) Strings.

Parameters:

options - the options

Returns:

this IcebergEndpoint.Builder

putHadoopOptions

@NotNull
@NotNull IcebergEndpoint.Builder putHadoopOptions(@NotNull
 @NotNull Map<String,? extends String> opts)

Add the passed hadoop options to the builder.

Parameters:

opts - the options

Returns:

this IcebergEndpoint.Builder

dataInstructions

@NotNull
@NotNull IcebergEndpoint.Builder dataInstructions(@NotNull
 @NotNull Object instructions)

Set the opaque data instructions for Deephaven to use when fetching table data, for example an S3Instructions instance could be provided.

Parameters:

instructions - the data instructions.

Returns:

this IcebergEndpoint.Builder

build

@NotNull
@NotNull IcebergEndpoint.Named build(@NotNull
 @NotNull String name)

Construct a named IcebergEndpoint from the builder state.

Parameters:

name - the endpoint name.

Returns:

a new IcebergEndpoint.Named instance.

build

@NotNull
@NotNull IcebergEndpoint build()

Construct an anonymous IcebergEndpoint from the builder state.

Returns:

a new IcebergEndpoint.