org.apache.solr.client.api.endpoint.CollectionBackupApi Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of solr-api Show documentation

Apache Solr (module: api)

There is a newer version: 9.7.0

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *     http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.apache.solr.client.api.endpoint;

import io.swagger.v3.oas.annotations.Operation;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.PathParam;
import org.apache.solr.client.api.model.CreateCollectionBackupRequestBody;
import org.apache.solr.client.api.model.RestoreCollectionRequestBody;
import org.apache.solr.client.api.model.SolrJerseyResponse;
import org.apache.solr.client.api.model.SubResponseAccumulatingJerseyResponse;

/**
 * V2 API definition for creating a new "backup" of a specified collection
 *
 * This API is analogous to the v1 /admin/collections?action=BACKUP command.
 */
public interface CollectionBackupApi {

  @Path("/collections/{collectionName}/backups/{backupName}/versions")
  interface Create {
    @POST
    @Operation(
        summary = "Creates a new backup point for a collection",
        tags = {"collection-backups"})
    SolrJerseyResponse createCollectionBackup(
        @PathParam("collectionName") String collectionName,
        @PathParam("backupName") String backupName,
        CreateCollectionBackupRequestBody requestBody)
        throws Exception;
  }

  @Path("/backups/{backupName}/restore")
  interface Restore {
    @POST
    @Operation(
        summary = "Restores an existing backup point to a (potentially new) collection.",
        tags = {"collection-backups"})
    SubResponseAccumulatingJerseyResponse restoreCollection(
        @PathParam("backupName") String backupName, RestoreCollectionRequestBody requestBody)
        throws Exception;
  }
}