org.apache.gravitino.client

Class GravitinoClient.ClientBuilder

java.lang.Object

org.apache.gravitino.client.GravitinoClientBase.Builder<GravitinoClient>

org.apache.gravitino.client.GravitinoClient.ClientBuilder

Enclosing class:

GravitinoClient

public static class GravitinoClient.ClientBuilder
extends GravitinoClientBase.Builder<GravitinoClient>

Builder class for constructing a GravitinoClient.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	metalakeName The name of the metalake that the client is working on.

Fields inherited from class org.apache.gravitino.client.GravitinoClientBase.Builder

authDataProvider, checkVersion, headers, uri

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	ClientBuilder(java.lang.String uri) The private constructor for the Builder class.

Method Summary

Modifier and Type	Method and Description
GravitinoClient	build() Builds a new GravitinoClient instance.
GravitinoClient.ClientBuilder	withMetalake(java.lang.String metalakeName) Optional, set the metalake name for this client.

Methods inherited from class org.apache.gravitino.client.GravitinoClientBase.Builder

withCustomTokenAuth, withHeaders, withKerberosAuth, withOAuth, withSimpleAuth, withSimpleAuth, withVersionCheckDisabled

Methods inherited from class java.lang.Object

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

Field Detail

metalakeName

protected java.lang.String metalakeName

The name of the metalake that the client is working on.

Constructor Detail

ClientBuilder

protected ClientBuilder(java.lang.String uri)

The private constructor for the Builder class.

Parameters:

uri - The base URI for the Gravitino API.

Method Detail

withMetalake

public GravitinoClient.ClientBuilder withMetalake(java.lang.String metalakeName)

Optional, set the metalake name for this client.

Parameters:

metalakeName - The name of the metalake that the client is working on.

Returns:

This Builder instance for method chaining.

build

public GravitinoClient build()

Builds a new GravitinoClient instance.

Specified by:

build in class GravitinoClientBase.Builder<GravitinoClient>

Returns:

A new instance of GravitinoClient with the specified base URI.

Throws:

java.lang.IllegalArgumentException - If the base URI is null or empty.

NoSuchMetalakeException - if the metalake with specified name does not exist.