Package org.apache.iceberg.rest

Class Endpoint

java.lang.Object

org.apache.iceberg.rest.Endpoint

public class Endpoint
extends Object

Holds an endpoint definition that consists of the HTTP method (GET, POST, DELETE, ...) and the resource path as defined in the Iceberg OpenAPI REST specification without parameter substitution, such as /v1/{prefix}/namespaces/{namespace}.

Field Summary

Fields

Modifier and Type	Field	Description
static final Endpoint	V1_CANCEL_TABLE_SCAN_PLAN
static final Endpoint	V1_COMMIT_TRANSACTION
static final Endpoint	V1_CREATE_NAMESPACE
static final Endpoint	V1_CREATE_TABLE
static final Endpoint	V1_CREATE_VIEW
static final Endpoint	V1_DELETE_NAMESPACE
static final Endpoint	V1_DELETE_TABLE
static final Endpoint	V1_DELETE_VIEW
static final Endpoint	V1_FETCH_TABLE_SCAN_PLAN
static final Endpoint	V1_FETCH_TABLE_SCAN_PLAN_TASKS
static final Endpoint	V1_LIST_NAMESPACES
static final Endpoint	V1_LIST_TABLES
static final Endpoint	V1_LIST_VIEWS
static final Endpoint	V1_LOAD_NAMESPACE
static final Endpoint	V1_LOAD_TABLE
static final Endpoint	V1_LOAD_VIEW
static final Endpoint	V1_NAMESPACE_EXISTS
static final Endpoint	V1_REGISTER_TABLE
static final Endpoint	V1_RENAME_TABLE
static final Endpoint	V1_RENAME_VIEW
static final Endpoint	V1_REPORT_METRICS
static final Endpoint	V1_SUBMIT_TABLE_SCAN_PLAN
static final Endpoint	V1_TABLE_CREDENTIALS
static final Endpoint	V1_TABLE_EXISTS
static final Endpoint	V1_UPDATE_NAMESPACE
static final Endpoint	V1_UPDATE_TABLE
static final Endpoint	V1_UPDATE_VIEW
static final Endpoint	V1_VIEW_EXISTS

Method Summary

Modifier and Type	Method	Description
static void	check(Set<Endpoint> supportedEndpoints, Endpoint endpoint)	Checks if the set of endpoints support the given Endpoint.
static void	check(Set<Endpoint> supportedEndpoints, Endpoint endpoint, org.apache.iceberg.relocated.com.google.common.base.Supplier<RuntimeException> supplier)	Checks if the set of endpoints support the given Endpoint.
static Endpoint	create(String httpMethod, String path)
boolean	equals(Object o)
static Endpoint	fromString(String endpoint)
int	hashCode()
String	httpMethod()
String	path()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

V1_LIST_NAMESPACES

public static final Endpoint V1_LIST_NAMESPACES

V1_LOAD_NAMESPACE

public static final Endpoint V1_LOAD_NAMESPACE

V1_NAMESPACE_EXISTS

public static final Endpoint V1_NAMESPACE_EXISTS

V1_CREATE_NAMESPACE

public static final Endpoint V1_CREATE_NAMESPACE

V1_UPDATE_NAMESPACE

public static final Endpoint V1_UPDATE_NAMESPACE

V1_DELETE_NAMESPACE

public static final Endpoint V1_DELETE_NAMESPACE

V1_COMMIT_TRANSACTION

public static final Endpoint V1_COMMIT_TRANSACTION

V1_LIST_TABLES

public static final Endpoint V1_LIST_TABLES

V1_LOAD_TABLE

public static final Endpoint V1_LOAD_TABLE

V1_TABLE_EXISTS

public static final Endpoint V1_TABLE_EXISTS

V1_CREATE_TABLE

public static final Endpoint V1_CREATE_TABLE

V1_UPDATE_TABLE

public static final Endpoint V1_UPDATE_TABLE

V1_DELETE_TABLE

public static final Endpoint V1_DELETE_TABLE

V1_RENAME_TABLE

public static final Endpoint V1_RENAME_TABLE

V1_REGISTER_TABLE

public static final Endpoint V1_REGISTER_TABLE

V1_REPORT_METRICS

public static final Endpoint V1_REPORT_METRICS

V1_TABLE_CREDENTIALS

public static final Endpoint V1_TABLE_CREDENTIALS

V1_SUBMIT_TABLE_SCAN_PLAN

public static final Endpoint V1_SUBMIT_TABLE_SCAN_PLAN

V1_FETCH_TABLE_SCAN_PLAN

public static final Endpoint V1_FETCH_TABLE_SCAN_PLAN

V1_CANCEL_TABLE_SCAN_PLAN

public static final Endpoint V1_CANCEL_TABLE_SCAN_PLAN

V1_FETCH_TABLE_SCAN_PLAN_TASKS

public static final Endpoint V1_FETCH_TABLE_SCAN_PLAN_TASKS

V1_LIST_VIEWS

public static final Endpoint V1_LIST_VIEWS

V1_LOAD_VIEW

public static final Endpoint V1_LOAD_VIEW

V1_VIEW_EXISTS

public static final Endpoint V1_VIEW_EXISTS

V1_CREATE_VIEW

public static final Endpoint V1_CREATE_VIEW

V1_UPDATE_VIEW

public static final Endpoint V1_UPDATE_VIEW

V1_DELETE_VIEW

public static final Endpoint V1_DELETE_VIEW

V1_RENAME_VIEW

public static final Endpoint V1_RENAME_VIEW

Method Details

httpMethod

public String httpMethod()

path

public String path()

create

public static Endpoint create(String httpMethod,
 String path)

toString

public String toString()

Overrides:

toString in class Object

fromString

public static Endpoint fromString(String endpoint)

check

public static void check(Set<Endpoint> supportedEndpoints,
 Endpoint endpoint)

Checks if the set of endpoints support the given Endpoint.

Parameters:

supportedEndpoints - The set of supported endpoints to check

endpoint - The endpoint to check against the set of supported endpoints

Throws:

UnsupportedOperationException - if the given Endpoint is not included in the set of endpoints.

check

public static void check(Set<Endpoint> supportedEndpoints,
 Endpoint endpoint,
 org.apache.iceberg.relocated.com.google.common.base.Supplier<RuntimeException> supplier)

Checks if the set of endpoints support the given Endpoint.

Parameters:

supportedEndpoints - The set of supported endpoints to check

endpoint - The endpoint to check against the set of supported endpoints

supplier - The supplier throwing a RuntimeException if the given Endpoint is not included in the set of endpoints.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object