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

Class DeleteCollectionSnapshotAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.DeleteCollectionSnapshotAPI

@Path("/collections/{collName}/snapshots")
public class DeleteCollectionSnapshotAPI
extends AdminAPIBase

V2 API for Deleting Collection Snapshots.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	DeleteCollectionSnapshotAPI.DeleteSnapshotResponse	The Response for DeleteCollectionSnapshotAPI's deleteSnapshot(String, String, boolean, String)

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
DeleteCollectionSnapshotAPI(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
static org.apache.solr.common.cloud.ZkNodeProps	createRemoteMessage(String collectionName, boolean followAliases, String snapshotName, String asyncId)
DeleteCollectionSnapshotAPI.DeleteSnapshotResponse	deleteSnapshot(String collName, String snapshotName, boolean followAliases, String asyncId)	This API is analogous to V1's (POST /solr/admin/collections?action=DELETESNAPSHOT)

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

DeleteCollectionSnapshotAPI

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

Method Detail

deleteSnapshot

@DELETE
@Path("/{snapshotName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public DeleteCollectionSnapshotAPI.DeleteSnapshotResponse deleteSnapshot(@PathParam("collName")
                                                                         String collName,
                                                                         @PathParam("snapshotName")
                                                                         String snapshotName,
                                                                         @DefaultValue("false") @QueryParam("followAliases")
                                                                         boolean followAliases,
                                                                         @QueryParam("async")
                                                                         String asyncId)
                                                                  throws Exception

This API is analogous to V1's (POST /solr/admin/collections?action=DELETESNAPSHOT)

Throws:

Exception

createRemoteMessage

public static org.apache.solr.common.cloud.ZkNodeProps createRemoteMessage(String collectionName,
                                                                           boolean followAliases,
                                                                           String snapshotName,
                                                                           String asyncId)