Package io.unitycatalog.client.api

Class SchemasApi

java.lang.Object
io.unitycatalog.client.api.SchemasApi
@Generated(value="org.openapitools.codegen.languages.JavaClientCodegen", comments="Generator version: 7.5.0") public class SchemasApi extends Object

  • Constructor Details

    • SchemasApi

      public SchemasApi()

    • SchemasApi

      public SchemasApi(ApiClient apiClient)

  • Method Details

    • getApiException

      protected ApiException getApiException(String operationId, HttpResponse<InputStream> response) throws IOException
      Throws:
      IOException

    • createSchema

      public SchemaInfo createSchema(CreateSchema createSchema) throws ApiException
      Create a schema Creates a new schema in the specified catalog.
      Parameters:
      createSchema - (optional)
      Returns:
      SchemaInfo
      Throws:
      ApiException - if fails to make API call

    • createSchemaWithHttpInfo

      public ApiResponse<SchemaInfo> createSchemaWithHttpInfo(CreateSchema createSchema) throws ApiException
      Create a schema Creates a new schema in the specified catalog.
      Parameters:
      createSchema - (optional)
      Returns:
      ApiResponse<SchemaInfo>
      Throws:
      ApiException - if fails to make API call

    • deleteSchema

      public Object deleteSchema(String fullName, Boolean force) throws ApiException
      Delete a schema Deletes the specified schema from the parent catalog.
      Parameters:
      fullName - Full name of the schema. (required)
      force - Force deletion even if the catalog is not empty. (optional)
      Returns:
      Object
      Throws:
      ApiException - if fails to make API call

    • deleteSchemaWithHttpInfo

      public ApiResponse<Object> deleteSchemaWithHttpInfo(String fullName, Boolean force) throws ApiException
      Delete a schema Deletes the specified schema from the parent catalog.
      Parameters:
      fullName - Full name of the schema. (required)
      force - Force deletion even if the catalog is not empty. (optional)
      Returns:
      ApiResponse<Object>
      Throws:
      ApiException - if fails to make API call

    • getSchema

      public SchemaInfo getSchema(String fullName) throws ApiException
      Get a schema Gets the specified schema for a catalog.
      Parameters:
      fullName - Full name of the schema. (required)
      Returns:
      SchemaInfo
      Throws:
      ApiException - if fails to make API call

    • getSchemaWithHttpInfo

      public ApiResponse<SchemaInfo> getSchemaWithHttpInfo(String fullName) throws ApiException
      Get a schema Gets the specified schema for a catalog.
      Parameters:
      fullName - Full name of the schema. (required)
      Returns:
      ApiResponse<SchemaInfo>
      Throws:
      ApiException - if fails to make API call

    • listSchemas

      public ListSchemasResponse listSchemas(String catalogName, Integer maxResults, String pageToken) throws ApiException
      List schemas Gets an array of schemas for a catalog. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - Parent catalog for schemas of interest. (required)
      maxResults - Maximum number of schemas to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)
      pageToken - Opaque pagination token to go to next page based on previous query. (optional)
      Returns:
      ListSchemasResponse
      Throws:
      ApiException - if fails to make API call

    • listSchemasWithHttpInfo

      public ApiResponse<ListSchemasResponse> listSchemasWithHttpInfo(String catalogName, Integer maxResults, String pageToken) throws ApiException
      List schemas Gets an array of schemas for a catalog. There is no guarantee of a specific ordering of the elements in the array.
      Parameters:
      catalogName - Parent catalog for schemas of interest. (required)
      maxResults - Maximum number of schemas to return. - when set to a value greater than 0, the page length is the minimum of this value and a server configured value; - when set to 0, the page length is set to a server configured value; - when set to a value less than 0, an invalid parameter error is returned; (optional)
      pageToken - Opaque pagination token to go to next page based on previous query. (optional)
      Returns:
      ApiResponse<ListSchemasResponse>
      Throws:
      ApiException - if fails to make API call

    • updateSchema

      public SchemaInfo updateSchema(String fullName, UpdateSchema updateSchema) throws ApiException
      Update a schema Updates the specified schema.
      Parameters:
      fullName - Full name of the schema. (required)
      updateSchema - (optional)
      Returns:
      SchemaInfo
      Throws:
      ApiException - if fails to make API call

    • updateSchemaWithHttpInfo

      public ApiResponse<SchemaInfo> updateSchemaWithHttpInfo(String fullName, UpdateSchema updateSchema) throws ApiException
      Update a schema Updates the specified schema.
      Parameters:
      fullName - Full name of the schema. (required)
      updateSchema - (optional)
      Returns:
      ApiResponse<SchemaInfo>
      Throws:
      ApiException - if fails to make API call