Package org.projectnessie.api

Interface ContentsApi

  • @Consumes("application/json")
@Path("contents")
public interface ContentsApi

    • Method Summary

      All Methods Instance Methods Abstract Methods Deprecated Methods 
      Modifier and Type Method Description
      void deleteContents​(@Valid ContentsKey key, @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String branch, @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hash, String message)
      Deprecated.
      Contents getContents​(@Valid ContentsKey key, @Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") String ref)
      Get the properties of an object.
      MultiGetContentsResponse getMultipleContents​(@Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") String ref, @Valid @NotNull MultiGetContentsRequest request)  
      void setContents​(@Valid @NotNull ContentsKey key, @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String branch, @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") @NotNull String hash, String message, @Valid @NotNull Contents contents)
      Deprecated.

    • Method Detail

      • getContents

        @GET
@Produces("application/json")
@Path("{key}")
Contents getContents​(@Valid @PathParam("key")
                     @Valid ContentsKey key,
                     @Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") @QueryParam("ref")
                     @Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") String ref)
              throws NessieNotFoundException
        Get the properties of an object.
        Throws:
        NessieNotFoundException

      • getMultipleContents

        @POST
@Consumes("application/json")
MultiGetContentsResponse getMultipleContents​(@Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") @QueryParam("ref")
                                             @Pattern(regexp="^(([0-9a-fA-F]{16,64})|([A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?))$",message="Reference must be either a reference name or hash, start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain .. or consist of the hex representation of 8-32 bytes") String ref,
                                             @Valid @NotNull
                                             @Valid @NotNull MultiGetContentsRequest request)
                                      throws NessieNotFoundException
        Throws:
        NessieNotFoundException

      • setContents

        @POST
@Path("{key}")
@Consumes("application/json")
@Deprecated
void setContents​(@Valid @NotNull @PathParam("key")
                 @Valid @NotNull ContentsKey key,
                 @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") @QueryParam("branch")
                 @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String branch,
                 @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") @NotNull @QueryParam("hash")
                 @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") @NotNull String hash,
                 @QueryParam("message")
                 String message,
                 @Valid @NotNull
                 @Valid @NotNull Contents contents)
          throws NessieNotFoundException,
                 NessieConflictException
        Deprecated.
        create/update an object on a specific ref.
        Throws:
        NessieNotFoundException
        NessieConflictException

      • deleteContents

        @DELETE
@Path("{key}")
@Deprecated
void deleteContents​(@Valid @PathParam("key")
                    @Valid ContentsKey key,
                    @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") @QueryParam("branch")
                    @Pattern(regexp="^[A-Za-z](((?![.][.])[A-Za-z0-9./_-])*[A-Za-z0-9._-])?$",message="Reference name must start with a letter, followed by letters, digits, a ./_- character, not end with a slash, not contain ..") String branch,
                    @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") @QueryParam("hash")
                    @Pattern(regexp="^[0-9a-fA-F]{16,64}$",message="Hash must consist of the hex representation of 8-32 bytes") String hash,
                    @QueryParam("message")
                    String message)
             throws NessieNotFoundException,
                    NessieConflictException
        Deprecated.
        Delete a single object.
        Throws:
        NessieNotFoundException
        NessieConflictException