Package org.apache.solr.cli

Class SnapshotDescribeTool

java.lang.Object

org.apache.solr.cli.ToolBase

org.apache.solr.cli.SnapshotDescribeTool

All Implemented Interfaces:

Tool

public class SnapshotDescribeTool
extends ToolBase

Supports snapshot-describe command in the bin/solr script.

Field Summary

Fields inherited from class org.apache.solr.cli.ToolBase

runtime

Constructor Summary

Constructors

Constructor	Description
SnapshotDescribeTool(ToolRuntime runtime)

Method Summary

Modifier and Type	Method	Description
void	describeSnapshot(org.apache.solr.client.solrj.SolrClient solrClient, String collectionName, String snapshotName)
String	getName()	Defines the interface to a Solr tool that can be run from this command-line app.
org.apache.commons.cli.Options	getOptions()	Retrieve the Options supported by this tool.
void	runImpl(org.apache.commons.cli.CommandLine cli)

Methods inherited from class org.apache.solr.cli.ToolBase

echo, echoIfVerbose, getConnectionOptions, getRuntime, isVerbose, runTool

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.cli.Tool

getFooter, getHeader, getUsage

Constructor Details

SnapshotDescribeTool

public SnapshotDescribeTool(ToolRuntime runtime)

Method Details

getName

public String getName()

Description copied from interface: Tool

Defines the interface to a Solr tool that can be run from this command-line app.

getOptions

public org.apache.commons.cli.Options getOptions()

Description copied from interface: Tool

Retrieve the Options supported by this tool.

Specified by:

getOptions in interface Tool

Overrides:

getOptions in class ToolBase

Returns:

The Options this tool supports.

runImpl

public void runImpl(org.apache.commons.cli.CommandLine cli)
             throws Exception

Specified by:

runImpl in class ToolBase

Throws:

Exception

describeSnapshot

public void describeSnapshot(org.apache.solr.client.solrj.SolrClient solrClient,
 String collectionName,
 String snapshotName)