Class CoreBackupsApi.CreateBackup
- java.lang.Object
-
- org.apache.solr.client.solrj.SolrRequest<CoreBackupsApi.CreateBackupResponse>
-
- org.apache.solr.client.solrj.request.CoreBackupsApi.CreateBackup
-
- All Implemented Interfaces:
Serializable
- Enclosing class:
- CoreBackupsApi
public static class CoreBackupsApi.CreateBackup extends SolrRequest<CoreBackupsApi.CreateBackupResponse>
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest
SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType
-
-
Field Summary
-
Fields inherited from class org.apache.solr.client.solrj.SolrRequest
SUPPORTED_METHODS, useBinaryV2, usev2
-
-
Constructor Summary
Constructors Constructor Description CreateBackup(String coreName)
Create a CreateBackup request object.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected CoreBackupsApi.CreateBackupResponse
createResponse(SolrClient client)
Create a new SolrResponse to hold the response from the serverRequestWriter.ContentWriter
getContentWriter(String expectedType)
If a request object wants to do a push write, implement this method.SolrParams
getParams()
String
getRequestType()
This method defines the type of this Solr request.ResponseParser
getResponseParser()
void
setAsync(String async)
void
setBackupName(String backupName)
void
setCommitName(String commitName)
void
setIncremental(Boolean incremental)
void
setLocation(String location)
void
setPrevShardBackupId(String prevShardBackupId)
void
setRepository(String repository)
void
setShardBackupId(String shardBackupId)
-
Methods inherited from class org.apache.solr.client.solrj.SolrRequest
addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getStreamingResponseCallback, getUserPrincipal, process, process, requiresCollection, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2
-
-
-
-
Constructor Detail
-
CreateBackup
public CreateBackup(String coreName)
Create a CreateBackup request object.- Parameters:
coreName
- Path param - The name of the core.
-
-
Method Detail
-
setRepository
public void setRepository(String repository)
- Parameters:
repository
- The name of the repository to be used for backup.
-
setLocation
public void setLocation(String location)
- Parameters:
location
- The path where the backup will be created
-
setShardBackupId
public void setShardBackupId(String shardBackupId)
-
setPrevShardBackupId
public void setPrevShardBackupId(String prevShardBackupId)
-
setCommitName
public void setCommitName(String commitName)
- Parameters:
commitName
- The name of the commit which was used while taking a snapshot using the CREATESNAPSHOT command.
-
setIncremental
public void setIncremental(Boolean incremental)
- Parameters:
incremental
- To turn on incremental backup feature
-
setAsync
public void setAsync(String async)
- Parameters:
async
- Request ID to track this action which will be processed asynchronously.
-
setBackupName
public void setBackupName(String backupName)
- Parameters:
backupName
- A descriptive name for the backup. Only used by non-incremental backups.
-
getContentWriter
public RequestWriter.ContentWriter getContentWriter(String expectedType)
Description copied from class:SolrRequest
If a request object wants to do a push write, implement this method.- Overrides:
getContentWriter
in classSolrRequest<CoreBackupsApi.CreateBackupResponse>
- Parameters:
expectedType
- This is the type that the RequestWriter would like to get. But, it is OK to send any format
-
getRequestType
public String getRequestType()
Description copied from class:SolrRequest
This method defines the type of this Solr request.- Specified by:
getRequestType
in classSolrRequest<CoreBackupsApi.CreateBackupResponse>
-
getParams
public SolrParams getParams()
- Specified by:
getParams
in classSolrRequest<CoreBackupsApi.CreateBackupResponse>
-
createResponse
protected CoreBackupsApi.CreateBackupResponse createResponse(SolrClient client)
Description copied from class:SolrRequest
Create a new SolrResponse to hold the response from the server- Specified by:
createResponse
in classSolrRequest<CoreBackupsApi.CreateBackupResponse>
- Parameters:
client
- theSolrClient
the request will be sent to
-
getResponseParser
public ResponseParser getResponseParser()
- Overrides:
getResponseParser
in classSolrRequest<CoreBackupsApi.CreateBackupResponse>
- Returns:
- The
ResponseParser
-
-