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

Class CollectionAdminRequest.Modify

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

All Implemented Interfaces:

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

Enclosing class:

CollectionAdminRequest<T extends CollectionAdminResponse>

public static class CollectionAdminRequest.Modify
extends CollectionAdminRequest.AsyncCollectionSpecificAdminRequest

A Modify Collection request

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

Modifier and Type	Field	Description
protected Map<String,Object>	attributes

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

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

EMPTY

Method Summary

Modifier and Type	Method	Description
SolrParams	getParams()	The parameters for this request; never null.
CollectionAdminRequest.Modify	setAttribute(String key, Object value)	Sets the collection attribute to the given value
void	setAttributes(Map<String,Object> attributes)	Sets the attributes to be modified using the Modify Collection API.
CollectionAdminRequest.Modify	unsetAttribute(String key)	Removes the given key from the collection

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

Field Details

attributes

protected Map<String,Object> attributes

Method Details

setAttributes

public void setAttributes(Map<String,Object> attributes)

Sets the attributes to be modified using the Modify Collection API. Note: this method will overwrite any previously set attributes

Parameters:

attributes - a map of attribute key vs value

setAttribute

public CollectionAdminRequest.Modify setAttribute(String key,
 Object value)

Sets the collection attribute to the given value

Parameters:

key - a string attribute key, must be one of the entries documented in the Modify Collection API documentation

value - the attribute value for the given key

unsetAttribute

public CollectionAdminRequest.Modify unsetAttribute(String key)

Removes the given key from the collection

Parameters:

key - the string attribute key, must be one of the entries documented in the Modify Collection API documentation

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