Package org.apache.solr.client.solrj.request

Class CoreBackupsApi.CreateBackup

java.lang.Object
org.apache.solr.client.solrj.SolrRequest<SolrJerseyResponse>
org.apache.solr.client.solrj.request.CoreBackupsApi.CreateBackup
All Implemented Interfaces:
Serializable
Enclosing class:
CoreBackupsApi
public static class CoreBackupsApi.CreateBackup extends SolrRequest<SolrJerseyResponse>
See Also:

  • Constructor Details

    • CreateBackup

      public CreateBackup(String coreName)
      Create a CreateBackup request object.
      Parameters:
      coreName - Path param - The name of the core.

  • Method Details

    • 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 _expectedTypeIGNORE)
      Description copied from class: SolrRequest
      If a request object wants to do a push write, implement this method.
      Overrides:
      getContentWriter in class SolrRequest<SolrJerseyResponse>
      Parameters:
      _expectedTypeIGNORE - This is the type that the RequestWriter would like to get. But, it is OK to send any format

    • getApiVersion

      public SolrRequest.ApiVersion getApiVersion()
      Description copied from class: SolrRequest
      Indicates which API version this request will make

      Defaults implementation returns 'V1'.

      Overrides:
      getApiVersion in class SolrRequest<SolrJerseyResponse>

    • getParams

      public SolrParams getParams()
      Description copied from class: SolrRequest
      The parameters for this request; never null. The runtime type may be mutable but modifications may not affect this SolrRequest instance, as it may return a new instance here every time. If the subclass specifies the response type as ModifiableSolrParams, then one can expect it to change this request. If the subclass has a setter then one can expect this method to return the value set.
      Specified by:
      getParams in class SolrRequest<SolrJerseyResponse>

    • getQueryParams

      public Set<String> getQueryParams()
      Description copied from class: SolrRequest
      Parameter keys that are sent via the query string
      Overrides:
      getQueryParams in class SolrRequest<SolrJerseyResponse>

    • createResponse

      protected SolrJerseyResponse createResponse(NamedList<Object> namedList)
      Description copied from class: SolrRequest
      Create a new SolrResponse to hold the response from the server. If the response extends SolrResponse, then there's no need to use the arguments, as SolrResponse.setResponse(NamedList) will be called right after this method.
      Specified by:
      createResponse in class SolrRequest<SolrJerseyResponse>
      Parameters:
      namedList - from SolrClient.request(SolrRequest, String).

    • getResponseParser

      public ResponseParser getResponseParser()
      Overrides:
      getResponseParser in class SolrRequest<SolrJerseyResponse>
      Returns:
      The ResponseParser