Package org.apache.polaris.service.catalog.api

Class IcebergRestConfigurationApi

java.lang.Object

org.apache.polaris.service.catalog.api.IcebergRestConfigurationApi

@Path("/api/catalog/v1/config")
@Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen",
           date="2025-10-06T09:01:55.526548072Z[UTC]",
           comments="Generator version: 7.12.0")
public class IcebergRestConfigurationApi
extends Object

The ConfigurationApi API interface This file is automatically generated by the OpenAPI Code Generator based on configuration in the build.gradle file.

Constructor Summary

Constructors

Constructor	Description
IcebergRestConfigurationApi(IcebergRestConfigurationApiService service)

Method Summary

Modifier and Type	Method	Description
jakarta.ws.rs.core.Response	getConfig(String warehouse, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)	All REST clients should first call this route to get catalog configuration properties from the server to configure the catalog and its HTTP client.

Methods inherited from class java.lang.Object

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

Constructor Details

IcebergRestConfigurationApi

@Inject
public IcebergRestConfigurationApi(IcebergRestConfigurationApiService service)

Method Details

getConfig

@GET
@Produces("application/json")
@RolesAllowed("**")
@Timeout
public jakarta.ws.rs.core.Response getConfig(@QueryParam("warehouse")
 String warehouse,
 @Context
 org.apache.polaris.core.context.RealmContext realmContext,
 @Context
 jakarta.ws.rs.core.SecurityContext securityContext)

All REST clients should first call this route to get catalog configuration properties from the server to configure the catalog and its HTTP client. Configuration from the server consists of two sets of key/value pairs. - defaults - properties that should be used as default configuration; applied before client configuration - overrides - properties that should be used to override client configuration; applied after defaults and client configuration Catalog configuration is constructed by setting the defaults, then client- provided configuration, and finally overrides. The final property set is then used to configure the catalog. For example, a default configuration property might set the size of the client pool, which can be replaced with a client-specific setting. An override might be used to set the warehouse location, which is stored on the server rather than in client configuration. Common catalog configuration settings are documented at https://iceberg.apache.org/docs/latest/configuration/#catalog-properties The catalog configuration also holds an optional `endpoints` field that contains information about the endpoints supported by the server. If a server does not send the `endpoints` field, a default set of endpoints is assumed: - GET /v1/{prefix}/namespaces - POST /v1/{prefix}/namespaces - GET /v1/{prefix}/namespaces/{namespace} - DELETE /v1/{prefix}/namespaces/{namespace} - POST /v1/{prefix}/namespaces/{namespace}/properties - GET /v1/{prefix}/namespaces/{namespace}/tables - POST /v1/{prefix}/namespaces/{namespace}/tables - GET /v1/{prefix}/namespaces/{namespace}/tables/{table} - POST /v1/{prefix}/namespaces/{namespace}/tables/{table} - DELETE /v1/{prefix}/namespaces/{namespace}/tables/{table} - POST /v1/{prefix}/namespaces/{namespace}/register - POST /v1/{prefix}/namespaces/{namespace}/tables/{table}/metrics - POST /v1/{prefix}/tables/rename - POST /v1/{prefix}/transactions/commit Response type: CatalogConfig.

Parameters:

warehouse - Warehouse location or identifier to request from the service

Returns:

200 - Server specified configuration values.