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

Class ListCollectionSnapshotsAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.ListCollectionSnapshotsAPI

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

V2 API for Listing Collection Snapshots.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListCollectionSnapshotsAPI.ListSnapshotsResponse	The Response for ListCollectionSnapshotsAPI's listSnapshots(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
ListCollectionSnapshotsAPI(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)

Method Summary

Modifier and Type	Method	Description
ListCollectionSnapshotsAPI.ListSnapshotsResponse	listSnapshots(String collName)	This API is analogous to V1's (POST /solr/admin/collections?action=LISTSNAPSHOTS)

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, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse

Methods inherited from class java.lang.Object

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

Constructor Detail

ListCollectionSnapshotsAPI

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

Method Detail

listSnapshots

@GET
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public ListCollectionSnapshotsAPI.ListSnapshotsResponse listSnapshots(@PathParam("collName")
                                                                      String collName)
                                                               throws Exception

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

Throws:

Exception