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

Class CreateCollectionSnapshotAPI

java.lang.Object

org.apache.solr.api.JerseyResource

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

org.apache.solr.handler.admin.api.CreateCollectionSnapshotAPI

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

V2 API for Creating Collection Snapshots.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CreateCollectionSnapshotAPI.CreateSnapshotRequestBody	The RequestBody for CreateCollectionSnapshotAPI's createSnapshot(String, String, CreateSnapshotRequestBody)
static class	CreateCollectionSnapshotAPI.CreateSnapshotResponse	The Response for CreateCollectionSnapshotAPI's createSnapshot(String, String, CreateSnapshotRequestBody)

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
CreateCollectionSnapshotAPI(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)
CreateCollectionSnapshotAPI.CreateSnapshotResponse	createSnapshot(String collName, String snapshotName, CreateCollectionSnapshotAPI.CreateSnapshotRequestBody requestBody)	This API is analogous to V1's (POST /solr/admin/collections?action=CREATESNAPSHOT)

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

CreateCollectionSnapshotAPI

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

Method Detail

createSnapshot

@POST
@Path("/{snapshotName}")
@Produces({"application/json","application/xml","application/vnd.apache.solr.javabin"})
public CreateCollectionSnapshotAPI.CreateSnapshotResponse createSnapshot(@PathParam("collName")
                                                                         String collName,
                                                                         @PathParam("snapshotName")
                                                                         String snapshotName,
                                                                         CreateCollectionSnapshotAPI.CreateSnapshotRequestBody requestBody)
                                                                  throws Exception

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

Throws:

Exception

createRemoteMessage

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