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

Class CollectionAdminRequest.Backup

java.lang.Object
org.apache.solr.client.solrj.SolrRequest<CollectionAdminResponse>
org.apache.solr.client.solrj.request.CollectionAdminRequest<CollectionAdminResponse>
org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionAdminRequest
org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionSpecificAdminRequest
org.apache.solr.client.solrj.request.CollectionAdminRequest.Backup
All Implemented Interfaces:
Serializable, MapSerializable, MapWriter, NavigableObject, org.noggit.JSONWriter.Writable
Enclosing class:
CollectionAdminRequest<T extends CollectionAdminResponse>
public static class CollectionAdminRequest.Backup extends CollectionAdminRequest.AsyncCollectionSpecificAdminRequest
See Also:

  • Field Details

    • name

      protected final String name

    • repositoryName

      protected Optional<String> repositoryName

    • location

      protected String location

    • commitName

      protected Optional<String> commitName

    • indexBackupStrategy

      protected Optional<String> indexBackupStrategy

    • incremental

      protected boolean incremental

    • maxNumBackupPoints

      protected Optional<Integer> maxNumBackupPoints

    • backupConfigset

      protected boolean backupConfigset

    • extraProperties

      protected Properties extraProperties

  • Constructor Details

  • Method Details

    • getLocation

      public String getLocation()

    • setLocation

      public CollectionAdminRequest.Backup setLocation(String location)

    • getRepositoryName

      public Optional<String> getRepositoryName()

    • setRepositoryName

      public CollectionAdminRequest.Backup setRepositoryName(String repositoryName)

    • getCommitName

      public Optional<String> getCommitName()

    • setCommitName

      public CollectionAdminRequest.Backup setCommitName(String commitName)

    • getIndexBackupStrategy

      public Optional<String> getIndexBackupStrategy()

    • setIndexBackupStrategy

      public CollectionAdminRequest.Backup setIndexBackupStrategy(String indexBackupStrategy)

    • setIncremental

      @Deprecated public CollectionAdminRequest.Backup setIncremental(boolean incremental)
      Deprecated.
      Specifies the backup method to use: the deprecated 'full-snapshot' format, or the current 'incremental' format.

      Defaults to 'true' if unspecified.

      Incremental backups are almost always preferable to the deprecated 'full-snapshot' format, as incremental backups can take advantage of previously backed-up files and will only upload those that aren't already stored in the repository - saving lots of time and network bandwidth. The older 'full-snapshot' format should only be used by experts with a particular reason to do so.

      Parameters:
      incremental - true to use incremental backups, false otherwise.

    • setMaxNumberBackupPoints

      public CollectionAdminRequest.Backup setMaxNumberBackupPoints(int maxNumBackupPoints)
      Specifies the maximum number of backup points to keep at the backup location.

      If the current backup causes the number of stored backup points to exceed this value, the oldest backup points are cleaned up so that only #maxNumBackupPoints are retained.

      This parameter is ignored if the request uses a non-incremental backup.

      Parameters:
      maxNumBackupPoints - the number of backup points to retain after the current backup

    • setBackupConfigset

      public CollectionAdminRequest.Backup setBackupConfigset(boolean backupConfigset)
      Indicates weather the Backup operation should also backup the configset files (such as schema.xml, solrconfig.xml. etc).

      Note that the configset is needed to restore the collection, so only set this to false if you know the cluster will have the configset available before restoring.

      Parameters:
      backupConfigset - true if you want to backup configsets (default). false to skip configset files.
      Returns:
      this builder

    • setExtraProperties

      public CollectionAdminRequest.Backup setExtraProperties(Properties extraProperties)

    • 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.
      Overrides:
      getParams in class CollectionAdminRequest.AsyncCollectionSpecificAdminRequest