Package io.deephaven.enterprise.iceberg

Class IcebergEndpoint

java.lang.Object

io.deephaven.enterprise.iceberg.IcebergEndpoint

Direct Known Subclasses:

IcebergEndpoint.Named

public class IcebergEndpoint
extends Object

The complete configuration required to locate an Iceberg table within a Catalog and then fetch the Iceberg table into Deephaven.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	IcebergEndpoint.Builder	A Builder object for construction of a IcebergEndpoint.
static class	IcebergEndpoint.Named	An IcebergEndpoint that is also named.

Method Summary

Modifier and Type	Method	Description
static @NotNull IcebergEndpoint	fromJson(@NotNull String jsonString)	Create a new IcebergEndpoint from the encoded JSON string.
@NotNull IcebergConfiguration	getConfiguration()	Get the configuration parameters needed to connect to an Iceberg Catalog and fetch Iceberg Tables.
@NotNull IcebergDataInstructions	getDataInstructions()	Get the IcebergDataInstructions that can be used to create appropriate instructions for use with IcebergReadInstructions.Builder.dataInstructions(Object).
@NotNull String	toJson()	Get this object encoded as a JSON string.
@NotNull IcebergEndpoint.Named	withName(@NotNull String name)	Get a copy of this endpoint, decorated with a name.

Methods inherited from class java.lang.Object

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

Method Details

getConfiguration

@NotNull
public @NotNull IcebergConfiguration getConfiguration()

Get the configuration parameters needed to connect to an Iceberg Catalog and fetch Iceberg Tables.

Returns:

the IcebergConfiguration object.

getDataInstructions

@NotNull
public @NotNull IcebergDataInstructions getDataInstructions()

Get the IcebergDataInstructions that can be used to create appropriate instructions for use with IcebergReadInstructions.Builder.dataInstructions(Object).

Returns:

the IcebergDataInstructions

withName

@NotNull
public @NotNull IcebergEndpoint.Named withName(@NotNull
 @NotNull String name)

Get a copy of this endpoint, decorated with a name.

Parameters:

name - the name to decorate with.

Returns:

a new IcebergEndpoint.Named with the same catalog and data instructions.

toJson

@NotNull
public @NotNull String toJson()
                       throws IOException

Get this object encoded as a JSON string.

Returns:

this object encoded as JSON.

Throws:

IOException - if the object could not be encoded for some reason.

fromJson

@NotNull
public static @NotNull IcebergEndpoint fromJson(@NotNull
 @NotNull String jsonString)
                                         throws IOException

Create a new IcebergEndpoint from the encoded JSON string.

Parameters:

jsonString - the encoded object.

Returns:

a new IcebergEndpoint

Throws:

IOException - if the JSON string could not be decoded.