Package org.apache.polaris.service.admin.api

Class PolarisCatalogsApi

java.lang.Object
org.apache.polaris.service.admin.api.PolarisCatalogsApi
@Path("/api/management/v1/catalogs") @Generated(value="org.openapitools.codegen.languages.JavaResteasyServerCodegen", date="2025-10-06T09:01:49.455628396Z[UTC]", comments="Generator version: 7.12.0") public class PolarisCatalogsApi extends Object
The catalogs 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
    PolarisCatalogsApi(PolarisCatalogsApiService service)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    addGrantToCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Valid org.apache.polaris.core.admin.model.AddGrantRequest addGrantRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Add a new grant to the catalog role Response type: Void.
    jakarta.ws.rs.core.Response
    createCatalog(@Valid org.apache.polaris.core.admin.model.CreateCatalogRequest createCatalogRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Add a new Catalog Response type: Void.
    jakarta.ws.rs.core.Response
    createCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Valid org.apache.polaris.core.admin.model.CreateCatalogRoleRequest createCatalogRoleRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Create a new role in the catalog Response type: Void.
    jakarta.ws.rs.core.Response
    deleteCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Delete an existing catalog.
    jakarta.ws.rs.core.Response
    deleteCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Delete an existing role from the catalog.
    jakarta.ws.rs.core.Response
    getCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Get the details of a catalog Response type: Catalog.
    jakarta.ws.rs.core.Response
    getCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Get the details of an existing role Response type: CatalogRole.
    jakarta.ws.rs.core.Response
    listAssigneePrincipalRolesForCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List the PrincipalRoles to which the target catalog role has been assigned Response type: PrincipalRoles.
    jakarta.ws.rs.core.Response
    listCatalogRoles(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List existing roles in the catalog Response type: CatalogRoles.
    jakarta.ws.rs.core.Response
    listCatalogs(org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List all catalogs in this polaris service Response type: Catalogs.
    jakarta.ws.rs.core.Response
    listGrantsForCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    List the grants the catalog role holds Response type: GrantResources.
    jakarta.ws.rs.core.Response
    revokeGrantFromCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, Boolean cascade, @Valid org.apache.polaris.core.admin.model.RevokeGrantRequest revokeGrantRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Delete a specific grant from the role.
    jakarta.ws.rs.core.Response
    updateCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Valid org.apache.polaris.core.admin.model.UpdateCatalogRequest updateCatalogRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Update an existing catalog Response type: Catalog.
    jakarta.ws.rs.core.Response
    updateCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Valid org.apache.polaris.core.admin.model.UpdateCatalogRoleRequest updateCatalogRoleRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    Update an existing role in the catalog Response type: CatalogRole.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • addGrantToCatalogRole

      @PUT @Path("/{catalogName}/catalog-roles/{catalogRoleName}/grants") @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response addGrantToCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Valid @Valid org.apache.polaris.core.admin.model.AddGrantRequest addGrantRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Add a new grant to the catalog role Response type: Void.
      Parameters:
      catalogName - Required - The name of the catalog where the role will receive the grant
      catalogRoleName - Required - The name of the role receiving the grant (must exist)
      addGrantRequest -
      Returns:
      201 - Successful response

    • createCatalog

      @POST @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response createCatalog(@Nonnull @Valid @Valid org.apache.polaris.core.admin.model.CreateCatalogRequest createCatalogRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Add a new Catalog Response type: Void.
      Parameters:
      createCatalogRequest - Required - The Catalog to create
      Returns:
      201 - Successful response

    • createCatalogRole

      @POST @Path("/{catalogName}/catalog-roles") @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response createCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Valid @Valid org.apache.polaris.core.admin.model.CreateCatalogRoleRequest createCatalogRoleRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Create a new role in the catalog Response type: Void.
      Parameters:
      catalogName - Required - The catalog for which we are reading/updating roles
      createCatalogRoleRequest -
      Returns:
      201 - Successful response

    • deleteCatalog

      @DELETE @Path("/{catalogName}") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response deleteCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Delete an existing catalog. The catalog must be empty. Response type: Void.
      Parameters:
      catalogName - Required - The name of the catalog
      Returns:
      204 - Success, no content

    • deleteCatalogRole

      @DELETE @Path("/{catalogName}/catalog-roles/{catalogRoleName}") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response deleteCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Delete an existing role from the catalog. All associated grants will also be deleted Response type: Void.
      Parameters:
      catalogName - Required - The catalog for which we are retrieving roles
      catalogRoleName - Required - The name of the role
      Returns:
      204 - Success, no content

    • getCatalog

      @GET @Path("/{catalogName}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response getCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Get the details of a catalog Response type: Catalog.
      Parameters:
      catalogName - Required - The name of the catalog
      Returns:
      200 - The catalog details

    • getCatalogRole

      @GET @Path("/{catalogName}/catalog-roles/{catalogRoleName}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response getCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Get the details of an existing role Response type: CatalogRole.
      Parameters:
      catalogName - Required - The catalog for which we are retrieving roles
      catalogRoleName - Required - The name of the role
      Returns:
      200 - The specified role details

    • listAssigneePrincipalRolesForCatalogRole

      @GET @Path("/{catalogName}/catalog-roles/{catalogRoleName}/principal-roles") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listAssigneePrincipalRolesForCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List the PrincipalRoles to which the target catalog role has been assigned Response type: PrincipalRoles.
      Parameters:
      catalogName - Required - The name of the catalog where the catalog role resides
      catalogRoleName - Required - The name of the catalog role
      Returns:
      200 - List the PrincipalRoles to which the target catalog role has been assigned

    • listCatalogRoles

      @GET @Path("/{catalogName}/catalog-roles") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listCatalogRoles(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List existing roles in the catalog Response type: CatalogRoles.
      Parameters:
      catalogName - Required - The catalog for which we are reading/updating roles
      Returns:
      200 - The list of roles that exist in this catalog

    • listCatalogs

      @GET @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listCatalogs(@Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List all catalogs in this polaris service Response type: Catalogs.
      Returns:
      200 - List of catalogs in the polaris service

    • listGrantsForCatalogRole

      @GET @Path("/{catalogName}/catalog-roles/{catalogRoleName}/grants") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listGrantsForCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      List the grants the catalog role holds Response type: GrantResources.
      Parameters:
      catalogName - Required - The name of the catalog where the role will receive the grant
      catalogRoleName - Required - The name of the role receiving the grant (must exist)
      Returns:
      200 - List of all grants given to the role in this catalog

    • revokeGrantFromCatalogRole

      @POST @Path("/{catalogName}/catalog-roles/{catalogRoleName}/grants") @Consumes("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response revokeGrantFromCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @DefaultValue("false") @QueryParam("cascade") Boolean cascade, @Valid @Valid org.apache.polaris.core.admin.model.RevokeGrantRequest revokeGrantRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Delete a specific grant from the role. This may be a subset or a superset of the grants the role has. In case of a subset, the role will retain the grants not specified. If the `cascade` parameter is true, grant revocation will have a cascading effect - that is, if a principal has specific grants on a subresource, and grants are revoked on a parent resource, the grants present on the subresource will be revoked as well. By default, this behavior is disabled and grant revocation only affects the specified resource. Response type: Void.
      Parameters:
      catalogName - Required - The name of the catalog where the role will receive the grant
      catalogRoleName - Required - The name of the role receiving the grant (must exist)
      cascade - If true, the grant revocation cascades to all subresources.
      revokeGrantRequest -
      Returns:
      201 - Successful response

    • updateCatalog

      @PUT @Path("/{catalogName}") @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response updateCatalog(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Nonnull @Valid @Valid org.apache.polaris.core.admin.model.UpdateCatalogRequest updateCatalogRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Update an existing catalog Response type: Catalog.
      Parameters:
      catalogName - Required - The name of the catalog
      updateCatalogRequest - Required - The catalog details to use in the update
      Returns:
      200 - The catalog details

    • updateCatalogRole

      @PUT @Path("/{catalogName}/catalog-roles/{catalogRoleName}") @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response updateCatalogRole(@Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogName, @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) @PathParam("catalogRoleName") @Pattern(regexp="^(?!\\s*[s|S][y|Y][s|S][t|T][e|E][m|M]\\$).*$") @Size(min=1,max=256) String catalogRoleName, @Valid @Valid org.apache.polaris.core.admin.model.UpdateCatalogRoleRequest updateCatalogRoleRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      Update an existing role in the catalog Response type: CatalogRole.
      Parameters:
      catalogName - Required - The catalog for which we are retrieving roles
      catalogRoleName - Required - The name of the role
      updateCatalogRoleRequest -
      Returns:
      200 - The specified role details