com.datastrato.gravitino.client

Class GravitinoClient

java.lang.Object

com.datastrato.gravitino.client.GravitinoClient

All Implemented Interfaces:

SupportsMetalakes, java.io.Closeable, java.lang.AutoCloseable

public class GravitinoClient
extends java.lang.Object
implements SupportsMetalakes, java.io.Closeable

Gravitino Client for interacting with the Gravitino API, allowing the client to list, load, create, and alter Metalakes.

It uses an underlying RESTClient to send HTTP requests and receive responses from the API.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GravitinoClient.Builder Builder class for constructing a GravitinoClient.

Method Summary

Modifier and Type	Method and Description
GravitinoMetaLake	alterMetalake(NameIdentifier ident, MetalakeChange... changes) Alters a specific Metalake using the Gravitino API.
static GravitinoClient.Builder	builder(java.lang.String uri) Creates a new builder for constructing a GravitinoClient.
void	close() Closes the GravitinoClient and releases any underlying resources.
GravitinoMetaLake	createMetalake(NameIdentifier ident, java.lang.String comment, java.util.Map<java.lang.String,java.lang.String> properties) Creates a new Metalake using the Gravitino API.
boolean	dropMetalake(NameIdentifier ident) Drops a specific Metalake using the Gravitino API.
GravitinoVersion	getVersion() Retrieves the version of the Gravitino API.
GravitinoMetaLake[]	listMetalakes() Retrieves a list of Metalakes from the Gravitino API.
GravitinoMetaLake	loadMetalake(NameIdentifier ident) Loads a specific Metalake from the Gravitino API.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.datastrato.gravitino.SupportsMetalakes

metalakeExists

Method Detail

listMetalakes

public GravitinoMetaLake[] listMetalakes()

Retrieves a list of Metalakes from the Gravitino API.

Specified by:

listMetalakes in interface SupportsMetalakes

Returns:

An array of GravitinoMetaLake objects representing the Metalakes.

loadMetalake

public GravitinoMetaLake loadMetalake(NameIdentifier ident)
                               throws NoSuchMetalakeException

Loads a specific Metalake from the Gravitino API.

Specified by:

loadMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the Metalake to be loaded.

Returns:

A GravitinoMetaLake instance representing the loaded Metalake.

Throws:

NoSuchMetalakeException - If the specified Metalake does not exist.

createMetalake

public GravitinoMetaLake createMetalake(NameIdentifier ident,
                                        java.lang.String comment,
                                        java.util.Map<java.lang.String,java.lang.String> properties)
                                 throws MetalakeAlreadyExistsException

Creates a new Metalake using the Gravitino API.

Specified by:

createMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the new Metalake.

comment - The comment for the new Metalake.

properties - The properties of the new Metalake.

Returns:

A GravitinoMetaLake instance representing the newly created Metalake.

Throws:

MetalakeAlreadyExistsException - If a Metalake with the specified identifier already exists.

alterMetalake

public GravitinoMetaLake alterMetalake(NameIdentifier ident,
                                       MetalakeChange... changes)
                                throws NoSuchMetalakeException,
                                       java.lang.IllegalArgumentException

Alters a specific Metalake using the Gravitino API.

Specified by:

alterMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the Metalake to be altered.

changes - The changes to be applied to the Metalake.

Returns:

A GravitinoMetaLake instance representing the updated Metalake.

Throws:

NoSuchMetalakeException - If the specified Metalake does not exist.

java.lang.IllegalArgumentException - If the provided changes are invalid or not applicable.

dropMetalake

public boolean dropMetalake(NameIdentifier ident)

Drops a specific Metalake using the Gravitino API.

Specified by:

dropMetalake in interface SupportsMetalakes

Parameters:

ident - The identifier of the Metalake to be dropped.

Returns:

True if the Metalake was successfully dropped, false otherwise.

getVersion

public GravitinoVersion getVersion()

Retrieves the version of the Gravitino API.

Returns:

A GravitinoVersion instance representing the version of the Gravitino API.

close

public void close()

Closes the GravitinoClient and releases any underlying resources.

Specified by:

close in interface java.io.Closeable

Specified by:

close in interface java.lang.AutoCloseable

builder

public static GravitinoClient.Builder builder(java.lang.String uri)

Creates a new builder for constructing a GravitinoClient.

Parameters:

uri - The base URI for the Gravitino API.

Returns:

A new instance of the Builder class for constructing a GravitinoClient.