Package io.deephaven.enterprise.iceberg

Class IcebergS3Instructions

java.lang.Object

io.deephaven.enterprise.iceberg.IcebergS3Instructions

All Implemented Interfaces:

IcebergDataInstructions

public final class IcebergS3Instructions
extends Object
implements IcebergDataInstructions

An implementation of IcebergDataInstructions used to serialize and deserialize S3Instructions for fetching tables from an S3 store.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	IcebergS3Instructions.Deserializer	A deserializer for S3Instructions.
static final class	IcebergS3Instructions.Factory	The factory instance.
static final class	IcebergS3Instructions.Serializer	A serializer for S3Instructions that only writes values that do not match the deephaven default values.

Method Summary

Modifier and Type	Method	Description
@NotNull Object	getDataInstructions(@NotNull Map<String,String> additionalProperties)	Get a completed data instructions instance to use for fetching data from the underlying storage.

Methods inherited from class java.lang.Object

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

Method Details

getDataInstructions

@NotNull
public @NotNull Object getDataInstructions(@NotNull
 @NotNull Map<String,String> additionalProperties)

Description copied from interface: IcebergDataInstructions

Get a completed data instructions instance to use for fetching data from the underlying storage. A map of additional properties may be passed to convey additional information such as secrets before returning the value to the user.

Specified by:

getDataInstructions in interface IcebergDataInstructions

Parameters:

additionalProperties - extra properties to assist in instructions construction.

Returns:

a newly constructed instructions object for use with IcebergReadInstructions.Builder.dataInstructions(Object)