Package io.deephaven.enterprise.iceberg

Interface IcebergDataInstructions

All Known Implementing Classes:
IcebergS3Instructions
@InternalUseOnly public interface IcebergDataInstructions
This interface provides an adapter layer between type specific data instructions and JSON serialization for IcebergEndpoint.

Users should not directly interact with implementations of this interface and instead, pass an appropriate Instructions object to the builtin discovery system via IcebergEndpoint.Builder.dataInstructions(Object).

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Interface
    Description
    static interface 
    IcebergDataInstructions.Factory
    The factory interface for injecting implementations using ServiceLoader.

  • 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.

  • Method Details

    • getDataInstructions

      @NotNull @NotNull Object getDataInstructions(@NotNull @NotNull Map<String,String> additionalProperties)
      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.
      Parameters:
      additionalProperties - extra properties to assist in instructions construction.
      Returns:
      a newly constructed instructions object for use with IcebergReadInstructions.Builder.dataInstructions(Object)