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

Class PolarisCatalogGenericTableApi

java.lang.Object
org.apache.polaris.service.catalog.api.PolarisCatalogGenericTableApi
@Path("/api/catalog/polaris/v1/{prefix}/namespaces/{namespace}/generic-tables") @Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen", comments="Generator version: 7.12.0") public class PolarisCatalogGenericTableApi extends Object
The GenericTableApi 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
    PolarisCatalogGenericTableApi(PolarisCatalogGenericTableApiService service)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    createGenericTable(String prefix, String namespace, @Valid CreateGenericTableRequest createGenericTableRequest, String polarisGenericTableAccessDelegation, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Create a generic table under the given namespace, and return the created table information as a response.
    jakarta.ws.rs.core.Response
    dropGenericTable(String prefix, String namespace, String genericTable, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Remove a table under the given namespace from the catalog Response type: Void.
    jakarta.ws.rs.core.Response
    listGenericTables(String prefix, String namespace, String pageToken, @Min(1L) Integer pageSize, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Return all generic table identifiers under this namespace Response type: ListGenericTablesResponse.
    jakarta.ws.rs.core.Response
    loadGenericTable(String prefix, String namespace, String genericTable, String polarisGenericTableAccessDelegation, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Load a generic table from the catalog under the given namespace.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • createGenericTable

      @POST @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response createGenericTable(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @Nonnull @Valid @Valid CreateGenericTableRequest createGenericTableRequest, @HeaderParam("Polaris-Generic-Table-Access-Delegation") String polarisGenericTableAccessDelegation, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Create a generic table under the given namespace, and return the created table information as a response. Response type: LoadGenericTableResponse.
      Parameters:
      prefix - Required - An optional prefix in the path
      namespace - Required - A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.
      createGenericTableRequest - Required -
      polarisGenericTableAccessDelegation - Optional header indicating that the client supports delegated access using a specific mechanism. If the header is present, the server must either provide access using the requested mechanism or fail the request. If `vended-credentials` is specified, the server must return scoped storage credentials in the `storage-access-configs` field of the response.
      Returns:
      200 - Table result if successfully created a generic table.

    • dropGenericTable

      @DELETE @Path("/{generic-table}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response dropGenericTable(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @PathParam("generic-table") String genericTable, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Remove a table under the given namespace from the catalog Response type: Void.
      Parameters:
      prefix - Required - An optional prefix in the path
      namespace - Required - A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.
      genericTable - Required - A generic table name
      Returns:
      204 - Success, no content

    • listGenericTables

      @GET @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listGenericTables(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @QueryParam("pageToken") String pageToken, @QueryParam("pageSize") @Min(1L) @Min(1L) Integer pageSize, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Return all generic table identifiers under this namespace Response type: ListGenericTablesResponse.
      Parameters:
      prefix - Required - An optional prefix in the path
      namespace - Required - A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.
      pageToken -
      pageSize - For servers that support pagination, this signals an upper bound of the number of results that a client will receive. For servers that do not support pagination, clients may receive results larger than the indicated `pageSize`.
      Returns:
      200 - List of generic table identifiers.

    • loadGenericTable

      @GET @Path("/{generic-table}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response loadGenericTable(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @PathParam("generic-table") String genericTable, @HeaderParam("Polaris-Generic-Table-Access-Delegation") String polarisGenericTableAccessDelegation, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Load a generic table from the catalog under the given namespace. The response contains all table information passed during create. Response type: LoadGenericTableResponse.
      Parameters:
      prefix - Required - An optional prefix in the path
      namespace - Required - A namespace identifier as a single string. Multipart namespace parts must be separated by the namespace separator as indicated via the /config override `namespace-separator`, which defaults to the unit separator `0x1F` byte (url encoded `%1F`). To be compatible with older clients, servers must use both the advertised separator and `0x1F` as valid separators when decoding namespaces. The `namespace-separator` should be provided in a url encoded form.
      genericTable - Required - A generic table name
      polarisGenericTableAccessDelegation - Optional header indicating that the client supports delegated access using a specific mechanism. If the header is present, the server must either provide access using the requested mechanism or fail the request. If `vended-credentials` is specified, the server must return scoped storage credentials in the `storage-access-configs` field of the response.
      Returns:
      200 - Table result if successfully load a generic table.