alluxio.client.block

Interface BlockMasterClient

All Superinterfaces:

AutoCloseable, Client, Closeable

All Known Implementing Classes:

RetryHandlingBlockMasterClient

@ThreadSafe
public interface BlockMasterClient
extends Client

A client to use for interacting with a block master.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	BlockMasterClient.Factory Factory for BlockMasterClient.

Method Summary

Modifier and Type	Method and Description
void	decommissionWorker(DecommissionWorkerPOptions options) Decommission a worker.
BlockInfo	getBlockInfo(long blockId) Returns the BlockInfo for a block id.
BlockMasterInfo	getBlockMasterInfo(Set<BlockMasterInfo.BlockMasterInfoField> fields)
long	getCapacityBytes() Gets the total Alluxio capacity in bytes, on all the tiers of all the workers.
List<WorkerInfo>	getLostWorkerInfoList() Gets the worker information of lost workers.
long	getUsedBytes() Gets the total amount of used space in bytes, on all the tiers of all the workers.
List<WorkerInfo>	getWorkerInfoList() Gets the worker information of live workers(support older version Alluxio server).
List<WorkerLostStorageInfo>	getWorkerLostStorage()
List<WorkerInfo>	getWorkerReport(GetWorkerReportOptions options) Gets the worker information of selected workers and selected fields for report CLI.
void	removeDisabledWorker(RemoveDisabledWorkerPOptions options) Revert disabling a worker, enabling it to register to the cluster.

Methods inherited from interface alluxio.Client

connect, disconnect, getConfAddress, getRemoteHostName, getRemoteSockAddress, isClosed, isConnected

Methods inherited from interface java.io.Closeable

close

Method Detail

getWorkerInfoList

List<WorkerInfo> getWorkerInfoList()
                            throws IOException

Gets the worker information of live workers(support older version Alluxio server).

Returns:

a list of worker information

Throws:

IOException

getLostWorkerInfoList

List<WorkerInfo> getLostWorkerInfoList()
                                throws IOException

Gets the worker information of lost workers.

Returns:

a list of lost worker information

Throws:

IOException

removeDisabledWorker

void removeDisabledWorker(RemoveDisabledWorkerPOptions options)
                   throws IOException

Revert disabling a worker, enabling it to register to the cluster.

Parameters:

options - contains the info used to find the target worker(s)

Throws:

IOException

getWorkerReport

List<WorkerInfo> getWorkerReport(GetWorkerReportOptions options)
                          throws IOException

Gets the worker information of selected workers and selected fields for report CLI.

Parameters:

options - the client defined worker and field ranges

Returns:

a list of worker information

Throws:

IOException

getWorkerLostStorage

List<WorkerLostStorageInfo> getWorkerLostStorage()
                                          throws IOException

Returns:

a list of worker lost storage information

Throws:

IOException

getBlockInfo

BlockInfo getBlockInfo(long blockId)
                throws IOException

Returns the BlockInfo for a block id.

Parameters:

blockId - the block id to get the BlockInfo for

Returns:

the BlockInfo

Throws:

IOException

getBlockMasterInfo

BlockMasterInfo getBlockMasterInfo(Set<BlockMasterInfo.BlockMasterInfoField> fields)
                            throws IOException

Parameters:

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

Returns:

the BlockMasterInfo block master information

Throws:

IOException

getCapacityBytes

long getCapacityBytes()
               throws IOException

Gets the total Alluxio capacity in bytes, on all the tiers of all the workers.

Returns:

total capacity in bytes

Throws:

IOException

getUsedBytes

long getUsedBytes()
           throws IOException

Gets the total amount of used space in bytes, on all the tiers of all the workers.

Returns:

amount of used space in bytes

Throws:

IOException

decommissionWorker

void decommissionWorker(DecommissionWorkerPOptions options)
                 throws IOException

Decommission a worker.

Parameters:

options - method options

Throws:

AlluxioStatusException - if something goes wrong

IOException