package alluxio.grpc.meta

Get desktop application:
View/edit binary Protocol Buffers messages

* This interface contains meta master service endpoints for Alluxio clients.

• rpc Backup (BackupPRequest, BackupPStatus)

  meta_master.proto:179

  * Backs up the Alluxio master to the specified URI

  message BackupPRequest

  meta_master.proto:130

  • optional BackupPOptions options = 1

  • optional string targetDirectory = 2

• rpc GetBackupStatus (BackupStatusPRequest, BackupPStatus)

  meta_master.proto:184

  * Returns status of the latest backup.

  message BackupStatusPRequest

  meta_master.proto:149

  • optional string backupId = 1

• rpc GetConfigReport (GetConfigReportPOptions, GetConfigReportPResponse)

  meta_master.proto:189

  * Returns server-side configuration report.

  message GetConfigReportPOptions

  meta_master.proto:63

  (message has no fields)

  message GetConfigReportPResponse

  meta_master.proto:64

  • optional ConfigCheckReport report = 1

• rpc GetMasterInfo (GetMasterInfoPOptions, GetMasterInfoPResponse)

  meta_master.proto:194

  * Returns information about the master.

  message GetMasterInfoPOptions

  meta_master.proto:108

  • repeated MasterInfoField filter = 1

  message GetMasterInfoPResponse

  meta_master.proto:111

  • optional MasterInfo masterInfo = 1

• rpc Checkpoint (CheckpointPOptions, CheckpointPResponse)

  meta_master.proto:199

  * Creates a checkpoint in the primary master journal system.

  message CheckpointPOptions

  meta_master.proto:115

  (message has no fields)

  message CheckpointPResponse

  meta_master.proto:116

  • optional string masterHostname = 1

    The hostname of the master that did the checkpoint

• rpc ListProxyStatus (ListProxyStatusPRequest, ListProxyStatusPResponse)

  meta_master.proto:204

  * Returns the status of all known Proxy instances in the cluster.

  message ListProxyStatusPRequest

  meta_master.proto:161

  • optional ListProxyStatusPOptions options = 1

  message ListProxyStatusPResponse

  meta_master.proto:168

  • repeated ProxyStatus proxyStatuses = 1

* This interface contains meta master service endpoints for Alluxio clients to query cluster configuration.

• rpc GetConfiguration (GetConfigurationPOptions, GetConfigurationPResponse)

  meta_master.proto:237

  * Returns a list of Alluxio runtime configuration information.

  message GetConfigurationPOptions

  meta_master.proto:15

  • optional bool rawValue = 1

  • optional bool ignoreClusterConf = 2

  • optional bool ignorePathConf = 3

  message GetConfigurationPResponse

  meta_master.proto:20

  • repeated ConfigProperty clusterConfigs = 1

  • map<string, ConfigProperties> pathConfigs = 2

  • optional string clusterConfigHash = 3

  • optional string pathConfigHash = 4

  • optional int64 clusterConfigLastUpdateTime = 5

  • optional int64 pathConfigLastUpdateTime = 6

• rpc SetPathConfiguration (SetPathConfigurationPRequest, SetPathConfigurationPResponse)

  meta_master.proto:242

  * Sets a property for a path.

  message SetPathConfigurationPRequest

  meta_master.proto:208

  • optional string path = 1

  • map<string, string> properties = 2

  • optional SetPathConfigurationPOptions options = 3

  message SetPathConfigurationPResponse

  meta_master.proto:213

  (message has no fields)

• rpc RemovePathConfiguration (RemovePathConfigurationPRequest, RemovePathConfigurationPResponse)

  meta_master.proto:247

  * Removes properties for a path, if the keys are empty, it means remove all properties.

  message RemovePathConfigurationPRequest

  meta_master.proto:216

  • optional string path = 1

  • repeated string keys = 2

  • optional RemovePathConfigurationPOptions options = 3

  message RemovePathConfigurationPResponse

  meta_master.proto:221

  (message has no fields)

• rpc GetConfigHash (GetConfigHashPOptions, GetConfigHashPResponse)

  meta_master.proto:252

  * Returns the hashes of cluster and path level configurations.

  message GetConfigHashPOptions

  meta_master.proto:223

  (message has no fields)

  message GetConfigHashPResponse

  meta_master.proto:224

  • optional string clusterConfigHash = 1

  • optional string pathConfigHash = 2

• rpc UpdateConfiguration (UpdateConfigurationPRequest, UpdateConfigurationPResponse)

  meta_master.proto:254

  message UpdateConfigurationPRequest

  meta_master.proto:297

  • map<string, string> properties = 1

  message UpdateConfigurationPResponse

  meta_master.proto:301

  • map<string, bool> status = 1

* This interface contains meta master service endpoints for Alluxio standby masters.

• rpc GetMasterId (GetMasterIdPRequest, GetMasterIdPResponse)

  meta_master.proto:313

  * Returns a master id for the given master address.

  message GetMasterIdPRequest

  meta_master.proto:258

  • optional NetAddress masterAddress = 1

  • optional GetMasterIdPOptions options = 2

  message GetMasterIdPResponse

  meta_master.proto:262

  • optional int64 masterId = 1

• rpc RegisterMaster (RegisterMasterPRequest, RegisterMasterPResponse)

  meta_master.proto:318

  * Registers a master.

  message RegisterMasterPRequest

  meta_master.proto:279

  • optional int64 masterId = 1

  • optional RegisterMasterPOptions options = 2

  message RegisterMasterPResponse

  meta_master.proto:283

  (message has no fields)

• rpc MasterHeartbeat (MasterHeartbeatPRequest, MasterHeartbeatPResponse)

  meta_master.proto:323

  * Heartbeats to indicate the master is lost or not.

  message MasterHeartbeatPRequest

  meta_master.proto:289

  • optional int64 masterId = 1

  • optional MasterHeartbeatPOptions options = 2

  message MasterHeartbeatPResponse

  meta_master.proto:293

  • optional MetaCommand command = 1

* This interface contains meta master service endpoints for Alluxio Proxy instances.

• rpc ProxyHeartbeat (ProxyHeartbeatPRequest, ProxyHeartbeatPResponse)

  meta_master.proto:344

  * Stateless heartbeat from proxy instances to report the current status.

  message ProxyHeartbeatPRequest

  meta_master.proto:331

  • optional ProxyHeartbeatPOptions options = 1

  message ProxyHeartbeatPResponse

  meta_master.proto:334

  (message has no fields)

* This interface contains raft service endpoints for Alluxio masters.

• rpc UploadSnapshot (stream UploadSnapshotPRequest, stream UploadSnapshotPResponse)

  raft_journal.proto:84

  * Uploads a snapshot to primary master.

  message UploadSnapshotPRequest

  raft_journal.proto:54

  • optional SnapshotData data = 1

  message UploadSnapshotPResponse

  raft_journal.proto:59

  • optional int64 offsetReceived = 1

• rpc DownloadSnapshot (stream DownloadSnapshotPRequest, stream DownloadSnapshotPResponse)

  raft_journal.proto:91

  * Downloads a snapshot from primary master.

  message DownloadSnapshotPRequest

  raft_journal.proto:64

  • optional int64 offsetReceived = 1

  message DownloadSnapshotPResponse

  raft_journal.proto:69

  • optional SnapshotData data = 1

• rpc RequestLatestSnapshotInfo (LatestSnapshotInfoPRequest, SnapshotMetadata)

  raft_journal.proto:98

  * Requests information about snapshots on a particular machine.

  message LatestSnapshotInfoPRequest

  raft_journal.proto:74

  (message has no fields)

• rpc RequestLatestSnapshotData (SnapshotMetadata, stream SnapshotData)

  raft_journal.proto:103

  * Request to download the snapshot information from a particular machine.

Used in: JournalQueryRequest

• optional NetAddress serverAddress = 1

Used in: BackupPRequest

• optional bool localFileSystem = 1

• optional bool runAsync = 2

• optional bool allowLeader = 3

• optional bool bypassDelegation = 4

Used as response type in: MetaMasterClientService.Backup, MetaMasterClientService.GetBackupStatus

• optional string backupId = 1

• optional BackupState backupState = 2

• optional string backupHost = 3

• optional string backupUri = 4

• optional int64 entryCount = 5

• optional bytes backupError = 6

Used in: BackupPStatus

• None = 1

• Initiating = 2

• Transitioning = 3

• Running = 4

• Completed = 5

• Failed = 6

Used in: GetConfigReportPResponse

• map<string, InconsistentProperties> errors = 1

  Scope name as key

• map<string, InconsistentProperties> warns = 2

  Scope name as key

• optional ConfigStatus status = 3

Used in: GetConfigurationPResponse

• repeated ConfigProperty properties = 1

Used in: ConfigCheckReport

• PASSED = 1

• WARN = 2

• FAILED = 3

Used in: GetMasterIdPRequest

(message has no fields)

Used in: JournalQueryRequest

• optional SnapshotMetadata snapshotInfo = 1

Used in: JournalQueryResponse

• optional SnapshotMetadata latest = 1

Used in: JournalQueryRequest

(message has no fields)

Used in: ConfigCheckReport

• repeated InconsistentProperty properties = 1

Used in: InconsistentProperties

• optional string name = 1

• map<string, InconsistentPropertyValues> values = 2

Used in: InconsistentProperty

• repeated string values = 1

• optional GetSnapshotInfoRequest snapshotInfoRequest = 1

• optional GetSnapshotRequest snapshotRequest = 2

• optional AddQuorumServerRequest addQuorumServerRequest = 3

• optional GetSnapshotInfoResponse snapshotInfoResponse = 1

Used in: ListProxyStatusPRequest

(message has no fields)

Used in: MasterHeartbeatPRequest

• optional int64 lastCheckpointTime = 1

• optional int64 journalEntriesSinceCheckpoint = 2

Used in: GetMasterInfoPResponse

• optional string leaderMasterAddress = 1

• repeated NetAddress masterAddresses = 2

• optional int32 rpcPort = 3

• optional bool safeMode = 4

• optional int64 startTimeMs = 5

• optional int64 upTimeMs = 6

• optional string version = 7

• optional int32 webPort = 8

• repeated NetAddress workerAddresses = 9

• repeated string zookeeperAddresses = 10

  Empty means zookeeper is not enabled

• optional string clusterId = 11

• optional bool raftJournal = 12

• repeated string raftAddress = 13

• repeated MasterVersion masterVersions = 14

Used in: GetMasterInfoPOptions

• LEADER_MASTER_ADDRESS = 0

• MASTER_ADDRESSES = 1

• RPC_PORT = 2

• SAFE_MODE = 3

• START_TIME_MS = 4

• UP_TIME_MS = 5

• VERSION = 6

• WEB_PORT = 7

• WORKER_ADDRESSES = 8

• ZOOKEEPER_ADDRESSES = 9

• CLUSTER_ID = 10

• RAFT_JOURNAL = 11

• RAFT_ADDRESSES = 12

• MASTER_VERSION = 13

Used in: MasterInfo

• optional NetAddress addresses = 1

• optional string version = 2

• optional string state = 3

Used in: MasterHeartbeatPResponse

• MetaCommand_Unknown = 0

• MetaCommand_Nothing = 1

• MetaCommand_Register = 2

  Ask the standby master to re-register.

Used in: ProxyHeartbeatPRequest

• optional NetAddress proxyAddress = 1

• optional int64 startTime = 2

• optional BuildVersion version = 3

Used in: ListProxyStatusPResponse

• optional NetAddress address = 1

• optional string state = 2

• optional int64 startTime = 3

• optional int64 lastHeartbeatTime = 4

• optional BuildVersion version = 5

Used in: RegisterMasterPRequest

• repeated ConfigProperty configs = 1

• optional int64 startTimeMs = 2

• optional int64 losePrimacyTimeMs = 3

• optional string version = 4

• optional string revision = 5

Used in: RemovePathConfigurationPRequest

(message has no fields)

• MASTER = 1

• WORKER = 2

• CLIENT = 4

• SERVER = 3

• ALL = 7

• NONE = 0

Used in: SetPathConfigurationPRequest

(message has no fields)

Used as response type in: RaftJournalService.RequestLatestSnapshotData

Used as field type in: DownloadSnapshotPResponse, UploadSnapshotPRequest

• optional int64 snapshotTerm = 1

• optional int64 snapshotIndex = 2

• optional bytes chunk = 3

• optional int64 offset = 4

• optional bool eof = 5

Used as request type in: RaftJournalService.RequestLatestSnapshotData

Used as response type in: RaftJournalService.RequestLatestSnapshotInfo

Used as field type in: GetSnapshotInfoRequest, GetSnapshotInfoResponse

• optional int64 snapshotTerm = 1

• optional int64 snapshotIndex = 2

• optional bool exists = 3