alluxio.client.meta

Interface MetaMasterClient

All Superinterfaces:

AutoCloseable, Client, Closeable

All Known Implementing Classes:

RetryHandlingMetaMasterClient

public interface MetaMasterClient
extends Client

Interface for a meta master client.

Method Summary

Modifier and Type	Method and Description
BackupStatus	backup(BackupPRequest backupRequest) Takes a backup.
String	checkpoint() Creates a checkpoint in the primary master journal system.
BackupStatus	getBackupStatus(UUID backupId) Queries the status of a backup.
ConfigCheckReport	getConfigReport() Gets the server-side configuration check report.
MasterInfo	getMasterInfo(Set<MasterInfoField> masterInfoFields)

Methods inherited from interface alluxio.Client

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

Methods inherited from interface java.io.Closeable

close

Method Detail

backup

BackupStatus backup(BackupPRequest backupRequest)
             throws IOException

Takes a backup. Note: If backup request ask for async execution, it will return after initiating the backup. Status for the in-progress backup will be returned. getBackupStatus(java.util.UUID) should be called for querying the status of the on-going backup. Note: When leader has no standby in an HA cluster, it will reject backup. This could be allowed by passing "AllowLeader" option in the request.

Parameters:

backupRequest - the backup request

Returns:

status of backup

Throws:

IOException

getBackupStatus

BackupStatus getBackupStatus(UUID backupId)
                      throws IOException

Queries the status of a backup.

Parameters:

backupId - backup id

Returns:

the status of the latest backup

Throws:

IOException

getConfigReport

ConfigCheckReport getConfigReport()
                           throws IOException

Gets the server-side configuration check report.

Returns:

configuration check report

Throws:

IOException

getMasterInfo

MasterInfo getMasterInfo(Set<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

checkpoint

String checkpoint()
           throws IOException

Creates a checkpoint in the primary master journal system.

Returns:

the hostname of the master that did the checkpoint

Throws:

IOException