Package org.apache.solr.handler.admin.api

Class DeleteCollectionBackupAPI

java.lang.Object

org.apache.solr.api.JerseyResource

org.apache.solr.handler.admin.api.AdminAPIBase

org.apache.solr.handler.admin.api.BackupAPIBase

org.apache.solr.handler.admin.api.DeleteCollectionBackupAPI

public class DeleteCollectionBackupAPI
extends BackupAPIBase

V2 API definitions for collection-backup deletion.

These APIs are equivalent to the v1 '/admin/collections?action=DELETEBACKUP' command.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteCollectionBackupAPI.BackupDeletionResponseBody
static class	DeleteCollectionBackupAPI.PurgeUnusedFilesRequestBody	Request body for the garbageCollectUnusedBackupFiles(String, PurgeUnusedFilesRequestBody) API.
static class	DeleteCollectionBackupAPI.PurgeUnusedResponse
static class	DeleteCollectionBackupAPI.PurgeUnusedStats

Field Summary

Fields inherited from class org.apache.solr.handler.admin.api.AdminAPIBase

coreContainer, solrQueryRequest, solrQueryResponse

Fields inherited from class org.apache.solr.api.JerseyResource

containerRequestContext

Constructor Summary

Constructors

Constructor	Description
DeleteCollectionBackupAPI(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessage(String backupName, String backupId, Integer versionsToRetain, Boolean purgeUnused, String location, String repositoryName, String asyncId)
DeleteCollectionBackupAPI.BackupDeletionResponseBody	deleteMultipleBackupsByRecency(String backupName, Integer versionsToRetain, String location, String repositoryName, String asyncId)
DeleteCollectionBackupAPI.BackupDeletionResponseBody	deleteSingleBackupById(String backupName, String backupId, String location, String repositoryName, String asyncId)
static List<CreateCollectionBackupAPI.BackupDeletionData>	fromRemoteResponse(com.fasterxml.jackson.databind.ObjectMapper objectMapper, org.apache.solr.client.solrj.SolrResponse response)
DeleteCollectionBackupAPI.PurgeUnusedResponse	garbageCollectUnusedBackupFiles(String backupName, DeleteCollectionBackupAPI.PurgeUnusedFilesRequestBody requestBody)
static void	invokeFromV1Params(CoreContainer coreContainer, SolrQueryRequest req, SolrQueryResponse rsp)

Methods inherited from class org.apache.solr.handler.admin.api.BackupAPIBase

createBackupRepository, getAndValidateBackupLocation, getAndValidateIncrementalBackupLocation

Methods inherited from class org.apache.solr.handler.admin.api.AdminAPIBase

disableResponseCaching, fetchAndValidateZooKeeperAwareCoreContainer, insertIfNotNull, recordCollectionForLogAndTracing, resolveAndValidateAliasIfEnabled, resolveCollectionName, submitRemoteMessageAndHandleResponse, validateZooKeeperAwareCoreContainer

Methods inherited from class org.apache.solr.api.JerseyResource

ensureRequiredParameterProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

DeleteCollectionBackupAPI

@Inject
public DeleteCollectionBackupAPI(CoreContainer coreContainer,
                                 SolrQueryRequest solrQueryRequest,
                                 SolrQueryResponse solrQueryResponse)

Method Detail

deleteSingleBackupById

@Path("/backups/{backupName}/versions/{backupId}")
@DELETE
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public DeleteCollectionBackupAPI.BackupDeletionResponseBody deleteSingleBackupById(@PathParam("backupName")
                                                                                   String backupName,
                                                                                   @PathParam("backupId")
                                                                                   String backupId,
                                                                                   @QueryParam("location")
                                                                                   String location,
                                                                                   @QueryParam("repository")
                                                                                   String repositoryName,
                                                                                   @QueryParam("async")
                                                                                   String asyncId)
                                                                            throws Exception

Throws:

Exception

deleteMultipleBackupsByRecency

@Path("/backups/{backupName}/versions")
@DELETE
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public DeleteCollectionBackupAPI.BackupDeletionResponseBody deleteMultipleBackupsByRecency(@PathParam("backupName")
                                                                                           String backupName,
                                                                                           @QueryParam("retainLatest")
                                                                                           Integer versionsToRetain,
                                                                                           @QueryParam("location")
                                                                                           String location,
                                                                                           @QueryParam("repository")
                                                                                           String repositoryName,
                                                                                           @QueryParam("async")
                                                                                           String asyncId)
                                                                                    throws Exception

Throws:

Exception

garbageCollectUnusedBackupFiles

@Path("/backups/{backupName}/purgeUnused")
@PUT
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public DeleteCollectionBackupAPI.PurgeUnusedResponse garbageCollectUnusedBackupFiles(@PathParam("backupName")
                                                                                     String backupName,
                                                                                     DeleteCollectionBackupAPI.PurgeUnusedFilesRequestBody requestBody)
                                                                              throws Exception

Throws:

Exception

createRemoteMessage

public static org.apache.solr.common.cloud.ZkNodeProps createRemoteMessage(String backupName,
                                                                           String backupId,
                                                                           Integer versionsToRetain,
                                                                           Boolean purgeUnused,
                                                                           String location,
                                                                           String repositoryName,
                                                                           String asyncId)

invokeFromV1Params

public static void invokeFromV1Params(CoreContainer coreContainer,
                                      SolrQueryRequest req,
                                      SolrQueryResponse rsp)
                               throws Exception

Throws:

Exception

fromRemoteResponse

public static List<CreateCollectionBackupAPI.BackupDeletionData> fromRemoteResponse(com.fasterxml.jackson.databind.ObjectMapper objectMapper,
                                                                                    org.apache.solr.client.solrj.SolrResponse response)