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

Class CollectionAdminRequest.DeleteBackup

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.DeleteBackup

All Implemented Interfaces:

Serializable, MapSerializable, MapWriter, NavigableObject, org.noggit.JSONWriter.Writable

Enclosing class:

CollectionAdminRequest<T extends CollectionAdminResponse>

public static class CollectionAdminRequest.DeleteBackup
extends CollectionAdminRequest<CollectionAdminResponse>

SolrRequest class for the "Backup Deletion" API.

Currently the API represented by this class only supports deletion of the new "incremental" backup file-format introduced in Solr 8.9. It should not be used on locations holding "non-incremental" backups (those created prior to 8.9, or after 8.9 using the advanced "incremental=false" flag).

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.ApiVersion, SolrRequest.METHOD, SolrRequest.SolrClientContext, SolrRequest.SolrRequestType

Nested classes/interfaces inherited from interface org.apache.solr.common.MapWriter

MapWriter.EntryWriter

Field Summary

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

Fields inherited from interface org.apache.solr.common.MapWriter

EMPTY

Method Summary

Modifier and Type	Method	Description
protected CollectionAdminResponse	createResponse(NamedList<Object> namedList)	Create a new SolrResponse to hold the response from the server.
SolrParams	getParams()	The parameters for this request; never null.
protected CollectionAdminRequest.DeleteBackup	setBackupId(int backupId)
CollectionAdminRequest.DeleteBackup	setLocation(String backupLocation)
protected CollectionAdminRequest.DeleteBackup	setMaxNumBackupPoints(int backupPointsToRetain)
protected CollectionAdminRequest.DeleteBackup	setPurgeUnused()	Configures the request to delete all unused files.
CollectionAdminRequest.DeleteBackup	setRepositoryName(String backupRepository)

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, installDataToShard, installDataToShard, listBackup, listCollections, migrateData, mockCollTask, modifyCollection, moveReplica, propagateBasicAuthCreds, rebalanceLeaders, reindexCollection, reloadCollection, removeRole, renameCollection, requestStatus, requiresCollection, restoreCollection, setAliasProperty, setClusterProperty, setCollectionProperty, splitShard, toString, waitForAsyncRequest, writeMap

Methods inherited from class org.apache.solr.client.solrj.SolrRequest

addHeader, addHeaders, getApiVersion, getBasicAuthPassword, getBasicAuthUser, getCollection, getContentStreams, getContentWriter, getHeaders, getMethod, getPath, getPreferredNodes, getQueryParams, getRequestType, getResponseParser, getStreamingResponseCallback, getUserPrincipal, process, process, processWithBaseUrl, setBasicAuthCredentials, setMethod, setPath, setPreferredNodes, setQueryParams, setRequestType, setResponseParser, setStreamingResponseCallback, setUserPrincipal

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.MapWriter

jsonStr, toMap, write

Methods inherited from interface org.apache.solr.common.NavigableObject

_forEachEntry, _forEachEntry, _forEachEntry, _get, _get, _getStr, _getStr, _size

Method Details

setRepositoryName

public CollectionAdminRequest.DeleteBackup setRepositoryName(String backupRepository)

Parameters:

backupRepository - the name of the repository implementation to use for accessing backup information. Defaults to 'LocalFileSystemRepository' if not specified.

setLocation

public CollectionAdminRequest.DeleteBackup setLocation(String backupLocation)

Parameters:

backupLocation - the location this request will use when accessing backup information. This parameter is not required - if not specified on the request, Solr will attempt to read a default location from BackupRepository configuration (solr.xml) and from cluster properties. If none of these places provide 'location' information an error will be thrown.

setBackupId

protected CollectionAdminRequest.DeleteBackup setBackupId(int backupId)

Parameters:

backupId - the ID of a single backup-point for this request to delete. Mutually exclusive with the parameters controlled by setMaxNumBackupPoints(int) and setPurgeUnused().

See Also:

• CollectionAdminRequest.deleteBackupById(String, int)

setMaxNumBackupPoints

protected CollectionAdminRequest.DeleteBackup setMaxNumBackupPoints(int backupPointsToRetain)

Parameters:

backupPointsToRetain - the number of backup-points to retain, deleting the reset. Mutually exclusive with the parameters controlled by setBackupId(int) and setPurgeUnused().

See Also:

• CollectionAdminRequest.deleteBackupByRecency(String, int)

setPurgeUnused

protected CollectionAdminRequest.DeleteBackup setPurgeUnused()

Configures the request to delete all unused files.

Mutually exclusive with the parameters controlled by setBackupId(int) and setMaxNumBackupPoints(int)

See Also:

• CollectionAdminRequest.deleteBackupPurgeUnusedFiles(String)

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<CollectionAdminResponse>

createResponse

protected CollectionAdminResponse 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<CollectionAdminResponse>

Parameters:

namedList - from SolrClient.request(SolrRequest, String).