Class ClusterProperty
java.lang.Object
org.apache.solr.api.JerseyResource
org.apache.solr.handler.admin.api.AdminAPIBase
org.apache.solr.handler.admin.api.ClusterProperty
- All Implemented Interfaces:
ClusterPropertyApis
-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected final org.apache.solr.common.cloud.ClusterPropertiesFields inherited from class org.apache.solr.handler.admin.api.AdminAPIBase
coreContainer, solrQueryRequest, solrQueryResponseFields inherited from class org.apache.solr.api.JerseyResource
containerRequestContext -
Constructor Summary
ConstructorsConstructorDescriptionClusterProperty(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse) -
Method Summary
Modifier and TypeMethodDescriptioncreateOrUpdateClusterProperty(String propertyName, SetClusterPropertyRequestBody requestBody) V2 API for setting the value of a single new or existing cluster property.createOrUpdateNestedClusterProperty(Map<String, Object> propertyValuesByName) V2 API for setting the value of nested cluster properties.deleteClusterProperty(String propertyName) V2 API for deleting a cluster property.getClusterProperty(String propertyName) V2 API for returning the value of a cluster property.V2 API for listing cluster properties.Methods inherited from class org.apache.solr.handler.admin.api.AdminAPIBase
disableResponseCaching, fetchAndValidateZooKeeperAwareCoreContainer, insertIfNotNull, recordCollectionForLogAndTracing, resolveAndValidateAliasIfEnabled, resolveCollectionName, submitRemoteMessageAndHandleResponse, validateZooKeeperAwareCoreContainerMethods inherited from class org.apache.solr.api.JerseyResource
ensureRequiredParameterProvided, ensureRequiredRequestBodyProvided, instantiateJerseyResponse, instantiateJerseyResponse
-
Field Details
-
clusterProperties
protected final org.apache.solr.common.cloud.ClusterProperties clusterProperties
-
-
Constructor Details
-
ClusterProperty
@Inject public ClusterProperty(CoreContainer coreContainer, SolrQueryRequest solrQueryRequest, SolrQueryResponse solrQueryResponse)
-
-
Method Details
-
listClusterProperties
V2 API for listing cluster properties.This API (GET /api/cluster/properties) has no v1 equivalent.
- Specified by:
listClusterPropertiesin interfaceClusterPropertyApis
-
getClusterProperty
V2 API for returning the value of a cluster property.This API (GET /api/cluster/properties/{propertyName}) has no v1 equivalent.
- Specified by:
getClusterPropertyin interfaceClusterPropertyApis
-
createOrUpdateClusterProperty
public SolrJerseyResponse createOrUpdateClusterProperty(String propertyName, SetClusterPropertyRequestBody requestBody) throws IOException V2 API for setting the value of a single new or existing cluster property.This API (PUT /api/cluster/properties/{propertyName} with an object listing the value) is equivalent to the v1 GET /solr/admin/collections?action=CLUSTERPROP&name={propertyName}&val={propertyValue} API.
- Specified by:
createOrUpdateClusterPropertyin interfaceClusterPropertyApis- Throws:
IOException
-
createOrUpdateNestedClusterProperty
public SolrJerseyResponse createOrUpdateNestedClusterProperty(Map<String, Object> propertyValuesByName) V2 API for setting the value of nested cluster properties.This API (PUT /api/cluster/properties with an object listing those properties) has no v1 equivalent.
- Specified by:
createOrUpdateNestedClusterPropertyin interfaceClusterPropertyApis
-
deleteClusterProperty
V2 API for deleting a cluster property.This API (DELETE /api/cluster/properties/{propertyName}) is equivalent to the v1 GET /solr/admin/collections?action=CLUSTERPROP&name={propertyName} API.
- Specified by:
deleteClusterPropertyin interfaceClusterPropertyApis
-