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

Class PolarisCatalogSemanticModelApi

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

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.ws.rs.core.Response
    createSemanticModel(String prefix, String namespace, @Valid CreateSemanticModelRequest createSemanticModelRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way.
    jakarta.ws.rs.core.Response
    dropSemanticModel(String prefix, String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way.
    jakarta.ws.rs.core.Response
    listSemanticModels(String prefix, String namespace, String pageToken, @Min(1L) Integer pageSize, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way.
    jakarta.ws.rs.core.Response
    loadSemanticModel(String prefix, String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way.
    jakarta.ws.rs.core.Response
    updateSemanticModel(String prefix, String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, @Valid UpdateSemanticModelRequest updateSemanticModelRequest, org.apache.polaris.core.context.RealmContext realmContext, jakarta.ws.rs.core.SecurityContext securityContext)
    **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way.

    Methods inherited from class java.lang.Object

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

  • Constructor Details

  • Method Details

    • createSemanticModel

      @POST @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response createSemanticModel(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @Nonnull @Valid @Valid CreateSemanticModelRequest createSemanticModelRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way. Creates a semantic model in the specified namespace. A semantic model is an Apache Ossie document describing datasets, fields, relationships, metrics, and AI context for a logical analytics surface above physical tables and views. Upon successful creation, the response returns the model's initial entity-version. Response type: LoadSemanticModelResponse.
      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.
      createSemanticModelRequest - Required -
      Returns:
      200 - Semantic model object result after creating a semantic model

    • dropSemanticModel

      @DELETE @Path("/{semantic-model-name}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response dropSemanticModel(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") @PathParam("semantic-model-name") @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way. Remove a semantic model 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.
      semanticModelName - Required -
      Returns:
      204 - Success, no content

    • listSemanticModels

      @GET @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response listSemanticModels(@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)
      **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way. List semantic-model identifiers under a namespace. Response type: ListSemanticModelsResponse.
      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 - A list of semantic model identifiers

    • loadSemanticModel

      @GET @Path("/{semantic-model-name}") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response loadSemanticModel(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") @PathParam("semantic-model-name") @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way. Load a semantic model from the catalog. Response type: LoadSemanticModelResponse.
      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.
      semanticModelName - Required -
      Returns:
      200 - Semantic model object result when loading a semantic model

    • updateSemanticModel

      @PUT @Path("/{semantic-model-name}") @Consumes("application/json") @Produces("application/json") @RolesAllowed("**") @Timeout public jakarta.ws.rs.core.Response updateSemanticModel(@PathParam("prefix") String prefix, @PathParam("namespace") String namespace, @Pattern(regexp="^[A-Za-z0-9\\-_]+$") @PathParam("semantic-model-name") @Pattern(regexp="^[A-Za-z0-9\\-_]+$") String semanticModelName, @Nonnull @Valid @Valid UpdateSemanticModelRequest updateSemanticModelRequest, @Context org.apache.polaris.core.context.RealmContext realmContext, @Context jakarta.ws.rs.core.SecurityContext securityContext)
      **Beta:** The semantic-model (Apache Ossie) API is under active development and may change in a backward-incompatible way. Replace a semantic model's document with a new one. Upon a successful update, the model's entity-version changes and the new value is returned. Updates use optimistic concurrency: supply the `entity-version` you last read for this model, and the update succeeds only if it matches the version currently stored in the catalog. A mismatch fails with 409. Response type: LoadSemanticModelResponse.
      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.
      semanticModelName - Required -
      updateSemanticModelRequest - Required -
      Returns:
      200 - Response when a semantic model is successfully updated. The updated Apache Ossie document is returned in the `document` field.