Class CollectionAdminRequest.Backup
- java.lang.Object
-
- org.apache.solr.client.solrj.SolrRequest<T>
-
- 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:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest
CollectionAdminRequest.AddReplica, CollectionAdminRequest.AddReplicaProp, CollectionAdminRequest.AddRole, CollectionAdminRequest.AsyncCollectionAdminRequest, CollectionAdminRequest.AsyncCollectionSpecificAdminRequest, CollectionAdminRequest.AsyncShardSpecificAdminRequest, CollectionAdminRequest.Backup, CollectionAdminRequest.BalanceShardUnique, CollectionAdminRequest.ClusterProp, CollectionAdminRequest.ClusterStatus, CollectionAdminRequest.CollectionAdminRoleRequest, CollectionAdminRequest.CollectionProp, CollectionAdminRequest.ColStatus, CollectionAdminRequest.Create, CollectionAdminRequest.CreateAlias, CollectionAdminRequest.CreateCategoryRoutedAlias, CollectionAdminRequest.CreateShard, CollectionAdminRequest.CreateSnapshot, CollectionAdminRequest.CreateTimeRoutedAlias, CollectionAdminRequest.Delete, CollectionAdminRequest.DeleteAlias, CollectionAdminRequest.DeleteBackup, CollectionAdminRequest.DeleteNode, CollectionAdminRequest.DeleteReplica, CollectionAdminRequest.DeleteReplicaProp, CollectionAdminRequest.DeleteShard, CollectionAdminRequest.DeleteSnapshot, CollectionAdminRequest.DeleteStatus, CollectionAdminRequest.DimensionalRoutedAlias, CollectionAdminRequest.ForceLeader, CollectionAdminRequest.InstallShard, CollectionAdminRequest.List, CollectionAdminRequest.ListAliases, CollectionAdminRequest.ListBackup, CollectionAdminRequest.ListSnapshots, CollectionAdminRequest.Migrate, CollectionAdminRequest.MockCollTask, CollectionAdminRequest.Modify, CollectionAdminRequest.MoveReplica, CollectionAdminRequest.OverseerStatus, CollectionAdminRequest.RebalanceLeaders, CollectionAdminRequest.ReindexCollection, CollectionAdminRequest.Reload, CollectionAdminRequest.RemoveRole, CollectionAdminRequest.Rename, CollectionAdminRequest.ReplaceNode, CollectionAdminRequest.RequestApiDistributedProcessing, CollectionAdminRequest.RequestApiDistributedProcessingResponse, CollectionAdminRequest.RequestStatus, CollectionAdminRequest.RequestStatusResponse, CollectionAdminRequest.Restore, CollectionAdminRequest.RoutedAliasAdminRequest, CollectionAdminRequest.SetAliasProperty, CollectionAdminRequest.ShardSpecificAdminRequest, CollectionAdminRequest.SplitShard
-
Nested classes/interfaces inherited from class org.apache.solr.client.solrj.SolrRequest
SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType
-
Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter
MapWriter.EntryWriter
-
-
Field Summary
Fields Modifier and Type Field Description protected boolean
backupConfigset
protected Optional<String>
commitName
protected Properties
extraProperties
protected boolean
incremental
protected Optional<String>
indexBackupStrategy
protected String
location
protected Optional<Integer>
maxNumBackupPoints
protected String
name
protected Optional<String>
repositoryName
-
Fields inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionSpecificAdminRequest
collection, followAliases
-
Fields inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionAdminRequest
asyncId, waitForFinalState
-
Fields inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest
action, MODIFIABLE_COLLECTION_PROPERTIES, PROPERTY_PREFIX
-
Fields inherited from class org.apache.solr.client.solrj.SolrRequest
SUPPORTED_METHODS, useBinaryV2, usev2
-
-
Method Summary
-
Methods inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionSpecificAdminRequest
getCollectionName, setFollowAliases
-
Methods inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest.AsyncCollectionAdminRequest
createResponse, getAsyncId, processAndWait, processAndWait, processAsync, processAsync, setAsyncId, setWaitForFinalState
-
Methods inherited from class org.apache.solr.client.solrj.request.CollectionAdminRequest
addProperties, addReplicaByRouteKey, addReplicaProperty, addReplicaToShard, addReplicaToShard, addRole, backupCollection, balanceReplicaProperty, collectionStatus, collectionStatuses, createAlias, createCategoryRoutedAlias, createCollection, createCollection, createCollection, createCollectionWithImplicitRouter, createCollectionWithImplicitRouter, createDimensionalRoutedAlias, createShard, createTimeRoutedAlias, deleteAlias, deleteAllAsyncIds, deleteAsyncId, deleteBackupById, deleteBackupByRecency, deleteBackupPurgeUnusedFiles, deleteCollection, deleteNode, deleteReplica, deleteReplica, deleteReplicaProperty, deleteReplicasFromAllShards, deleteReplicasFromShard, deleteShard, forceLeaderElection, getClusterStatus, getOverseerStatus, getRequestType, installDataToShard, installDataToShard, listBackup, listCollections, migrateData, mockCollTask, modifyCollection, moveReplica, propagateBasicAuthCreds, rebalanceLeaders, reindexCollection, reloadCollection, removeRole, renameCollection, requestStatus, restoreCollection, setAliasProperty, setClusterProperty, setCollectionProperty, splitShard, toString, waitForAsyncRequest, writeMap
-
Methods inherited from class org.apache.solr.client.solrj.SolrRequest
addHeader, addHeaders, getBasePath, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, requiresCollection, setBasePath, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setResponseParser, setStreamingResponseCallback, setUseBinaryV2, setUserPrincipal, setUseV2
-
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.apache.solr.common.NavigableObject
_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size
-
-
-
-
Field Detail
-
name
protected final String name
-
location
protected String location
-
incremental
protected boolean incremental
-
backupConfigset
protected boolean backupConfigset
-
extraProperties
protected Properties extraProperties
-
-
Method Detail
-
getLocation
public String getLocation()
-
setLocation
public CollectionAdminRequest.Backup setLocation(String location)
-
setRepositoryName
public CollectionAdminRequest.Backup setRepositoryName(String repositoryName)
-
setCommitName
public CollectionAdminRequest.Backup setCommitName(String commitName)
-
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()
- Overrides:
getParams
in classCollectionAdminRequest.AsyncCollectionSpecificAdminRequest
-
-