Package org.projectnessie.api.v1.http

Interface HttpNamespaceApi

All Superinterfaces:

NamespaceApi

@Path("v1/namespaces")
@Path("v1/namespaces")
@Consumes("application/json")
@Consumes("application/json")
public interface HttpNamespaceApi
extends NamespaceApi

Method Summary

Modifier and Type	Method	Description
Namespace	createNamespace(@NotNull @NotNull NamespaceParams params, @NotNull @NotNull Namespace namespace)	Creates a new namespace with Namespace properties.
void	deleteNamespace(@NotNull @NotNull NamespaceParams params)	Deletes the namespace if it doesn't contain any tables.
Namespace	getNamespace(@NotNull @NotNull NamespaceParams params)	Retrieves the Namespace instance if it exists.
GetNamespacesResponse	getNamespaces(@NotNull @NotNull MultipleNamespacesParams params)	Retrieves a list of Namespace instances that match a given namespace prefix.
void	updateProperties(@NotNull @NotNull NamespaceParams params, @NotNull @NotNull NamespaceUpdate namespaceUpdate)	Updates/removes properties for a given Namespace.

Method Details

createNamespace

@PUT
@PUT
@Path("/namespace/{ref}/{name}")
@Path("/namespace/{ref}/{name}")
@Produces("application/json")
@Produces("application/json")
Namespace createNamespace(@BeanParam @BeanParam @NotNull @NotNull
 @NotNull @NotNull NamespaceParams params,
 @NotNull @NotNull
 @NotNull @NotNull Namespace namespace)
                   throws NessieNamespaceAlreadyExistsException,
NessieReferenceNotFoundException

Description copied from interface: NamespaceApi

Creates a new namespace with Namespace properties.

Specified by:

createNamespace in interface NamespaceApi

Parameters:

params - The NamespaceParams that includes the parameters for the API call.

namespace - The instance including the namespace properties.

Returns:

A Namespace instance if creating the namespace succeeded.

Throws:

NessieNamespaceAlreadyExistsException - If the namespace already exists.

NessieReferenceNotFoundException - If the reference could not be found.

deleteNamespace

@DELETE
@DELETE
@Path("/namespace/{ref}/{name}")
@Path("/namespace/{ref}/{name}")
@Produces("application/json")
@Produces("application/json")
void deleteNamespace(@BeanParam @BeanParam @NotNull @NotNull
 @NotNull @NotNull NamespaceParams params)
              throws NessieReferenceNotFoundException,
NessieNamespaceNotEmptyException,
NessieNamespaceNotFoundException

Description copied from interface: NamespaceApi

Deletes the namespace if it doesn't contain any tables.

Specified by:

deleteNamespace in interface NamespaceApi

Parameters:

params - The NamespaceParams that includes the parameters for the API call.

Throws:

NessieReferenceNotFoundException - If the reference could not be found.

NessieNamespaceNotEmptyException - If the namespace is not empty and contains tables.

NessieNamespaceNotFoundException - If the namespace to be deleted could not be found.

getNamespace

@GET
@GET
@Path("/namespace/{ref}/{name}")
@Path("/namespace/{ref}/{name}")
@Produces("application/json")
@Produces("application/json")
Namespace getNamespace(@BeanParam @BeanParam @NotNull @NotNull
 @NotNull @NotNull NamespaceParams params)
                throws NessieNamespaceNotFoundException,
NessieReferenceNotFoundException

Description copied from interface: NamespaceApi

Retrieves the Namespace instance if it exists.

Specified by:

getNamespace in interface NamespaceApi

Parameters:

params - The NamespaceParams that includes the parameters for the API call.

Returns:

A Namespace instance if a namespace with the given name exists.

Throws:

NessieNamespaceNotFoundException - If the namespace does not exist.

NessieReferenceNotFoundException - If the reference could not be found.

getNamespaces

@GET
@GET
@Path("/{ref}")
@Path("/{ref}")
@Produces("application/json")
@Produces("application/json")
GetNamespacesResponse getNamespaces(@BeanParam @BeanParam @NotNull @NotNull
 @NotNull @NotNull MultipleNamespacesParams params)
                             throws NessieReferenceNotFoundException

Description copied from interface: NamespaceApi

Retrieves a list of Namespace instances that match a given namespace prefix.

Specified by:

getNamespaces in interface NamespaceApi

Parameters:

params - The MultipleNamespacesParams that includes the parameters for the API call.

Returns:

A GetNamespacesResponse instance containing all the namespaces that match the given namespace prefix.

Throws:

NessieReferenceNotFoundException - If the reference could not be found.

updateProperties

@POST
@POST
@Path("/namespace/{ref}/{name}")
@Path("/namespace/{ref}/{name}")
@Produces("application/json")
@Produces("application/json")
void updateProperties(@BeanParam @BeanParam @NotNull @NotNull
 @NotNull @NotNull NamespaceParams params,
 @NotNull @NotNull
 @NotNull @NotNull NamespaceUpdate namespaceUpdate)
               throws NessieNamespaceNotFoundException,
NessieReferenceNotFoundException

Description copied from interface: NamespaceApi

Updates/removes properties for a given Namespace.

Specified by:

updateProperties in interface NamespaceApi

Parameters:

params - The NamespaceParams that includes the parameters for the API call.

namespaceUpdate - The instance including the property updates/deletes.

Throws:

NessieNamespaceNotFoundException - If the namespace does not exist.

NessieReferenceNotFoundException - If the reference could not be found.