alluxio.client

Interface MetaMasterClient

All Superinterfaces:

AutoCloseable, Closeable

All Known Implementing Classes:

RetryHandlingMetaMasterClient

public interface MetaMasterClient
extends Closeable

Interface for a meta master client.

Method Summary

Modifier and Type	Method and Description
BackupResponse	backup(String dir, boolean localFileSystem) Writes a backup of the journal to the specified directory.
ConfigCheckReport	getConfigReport() Gets the server-side configuration check report.
List<ConfigProperty>	getConfiguration() Gets the runtime configuration information.
MasterInfo	getMasterInfo(Set<MasterInfo.MasterInfoField> masterInfoFields)
Map<String,MetricValue>	getMetrics() Gets a map of metrics property names and their values from metrics system.

Methods inherited from interface java.io.Closeable

close

Method Detail

backup

BackupResponse backup(@Nullable
                      String dir,
                      boolean localFileSystem)
               throws IOException

Writes a backup of the journal to the specified directory. The backup is written to the directory with a file name containing the date when the file was written.

Parameters:

dir - the directory in the UFS to write to, or null to use the default alluxio backup directory

localFileSystem - whether to write to the master's local filesystem instead of the UFS

Returns:

the server response

Throws:

IOException

getConfigReport

ConfigCheckReport getConfigReport()
                           throws IOException

Gets the server-side configuration check report.

Returns:

configuration check report

Throws:

IOException

getConfiguration

List<ConfigProperty> getConfiguration()
                               throws IOException

Gets the runtime configuration information.

Returns:

a list of configuration information

Throws:

IOException

getMasterInfo

MasterInfo getMasterInfo(Set<MasterInfo.MasterInfoField> masterInfoFields)
                  throws IOException

Parameters:

masterInfoFields - optional list of fields to query; if null all fields will be queried

Returns:

the requested master info

Throws:

IOException

getMetrics

Map<String,MetricValue> getMetrics()
                            throws AlluxioStatusException

Gets a map of metrics property names and their values from metrics system.

Returns:

a map of metrics information

Throws:

AlluxioStatusException