package alluxio.grpc.job

Get desktop application:
View/edit binary Protocol Buffers messages

* This interface contains job master service endpoints for job service clients.

• rpc Cancel (CancelPRequest, CancelPResponse)

  job_master.proto:262

  * Cancels the given job.

  message CancelPRequest

  job_master.proto:139

  • optional int64 jobId = 1

  • optional CancelPOptions options = 2

  message CancelPResponse

  job_master.proto:143

  (message has no fields)

• rpc GetJobStatus (GetJobStatusPRequest, GetJobStatusPResponse)

  job_master.proto:267

  * Gets the status of the given job.

  message GetJobStatusPRequest

  job_master.proto:146

  • optional int64 jobId = 1

  • optional GetJobStatusPOptions options = 2

  message GetJobStatusPResponse

  job_master.proto:150

  • optional JobInfo jobInfo = 1

• rpc GetJobStatusDetailed (GetJobStatusDetailedPRequest, GetJobStatusDetailedPResponse)

  job_master.proto:272

  * Gets the status of the given job.

  message GetJobStatusDetailedPRequest

  job_master.proto:155

  • optional int64 jobId = 1

  • optional GetJobStatusDetailedPOptions options = 2

  message GetJobStatusDetailedPResponse

  job_master.proto:159

  • optional JobInfo jobInfo = 1

• rpc GetJobServiceSummary (GetJobServiceSummaryPRequest, GetJobServiceSummaryPResponse)

  job_master.proto:277

  * Gets the summary of the job service.

  message GetJobServiceSummaryPRequest

  job_master.proto:186

  • optional GetJobServiceSummaryPOptions options = 1

  message GetJobServiceSummaryPResponse

  job_master.proto:189

  • optional JobServiceSummary summary = 1

• rpc ListAll (ListAllPRequest, ListAllPResponse)

  job_master.proto:282

  * Lists ids of all known jobs.

  message ListAllPRequest

  job_master.proto:168

  • optional ListAllPOptions options = 1

  message ListAllPResponse

  job_master.proto:171

  • repeated int64 jobIds = 1

  • repeated JobInfo jobInfos = 2

• rpc Run (RunPRequest, RunPResponse)

  job_master.proto:287

  * Starts the given job, returning a job id.

  message RunPRequest

  job_master.proto:177

  • optional bytes jobConfig = 1

  • optional RunPOptions options = 2

  message RunPResponse

  job_master.proto:181

  • optional int64 jobId = 1

• rpc GetAllWorkerHealth (GetAllWorkerHealthPRequest, GetAllWorkerHealthPResponse)

  job_master.proto:292

  * Lists all worker health.

  message GetAllWorkerHealthPRequest

  job_master.proto:194

  • optional GetAllWorkerHealthPOptions options = 1

  message GetAllWorkerHealthPResponse

  job_master.proto:197

  • repeated JobWorkerHealth workerHealths = 1

• rpc GetAllMasterStatus (GetAllMasterStatusPRequest, GetAllMasterStatusPResponse)

  job_master.proto:297

  * Lists all job master status.

  message GetAllMasterStatusPRequest

  job_master.proto:209

  • optional GetAllMasterStatusPOptions options = 1

  message GetAllMasterStatusPResponse

  job_master.proto:212

  • repeated JobMasterStatus jobMasterStatus = 1

• rpc Submit (SubmitRequest, SubmitResponse)

  job_master.proto:302

  * Submit a CMD job, return a jobControlId.

  message SubmitRequest

  job_master.proto:217

  • optional bytes cmdConfig = 1

  • optional SubmitOptions options = 2

  message SubmitResponse

  job_master.proto:221

  • optional int64 jobControlId = 1

• rpc GetCmdStatus (GetCmdStatusRequest, GetCmdStatusResponse)

  job_master.proto:307

  * Get status for a CMD job, return a status.

  message GetCmdStatusRequest

  job_master.proto:226

  • optional int64 jobControlId = 1

  • optional GetCmdStatusOptions options = 2

  message GetCmdStatusResponse

  job_master.proto:230

  • optional Status cmdStatus = 1

• rpc GetCmdStatusDetailed (GetCmdStatusDetailedRequest, GetCmdStatusDetailedResponse)

  job_master.proto:312

  * Get detailed status for a CMD job, return detailed status information.

  message GetCmdStatusDetailedRequest

  job_master.proto:235

  • optional int64 jobControlId = 1

  • optional GetCmdStatusOptions options = 2

  message GetCmdStatusDetailedResponse

  job_master.proto:250

  • optional CmdStatusBlock cmdStatusBlock = 1

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

• rpc GetMasterId (GetJobMasterIdPRequest, GetJobMasterIdPResponse)

  job_master.proto:396

  * Returns a master id for the given master address.

  message GetJobMasterIdPRequest

  job_master.proto:352

  • optional NetAddress masterAddress = 1

  • optional GetJobMasterIdPOptions options = 2

  message GetJobMasterIdPResponse

  job_master.proto:356

  • optional int64 masterId = 1

• rpc RegisterMaster (RegisterJobMasterPRequest, RegisterJobMasterPResponse)

  job_master.proto:401

  * Registers a master.

  message RegisterJobMasterPRequest

  job_master.proto:372

  • optional int64 jobMasterId = 1

  • optional RegisterJobMasterPOptions options = 2

  message RegisterJobMasterPResponse

  job_master.proto:376

  (message has no fields)

• rpc MasterHeartbeat (JobMasterHeartbeatPRequest, JobMasterHeartbeatPResponse)

  job_master.proto:406

  * Heartbeats to indicate the master is lost or not.

  message JobMasterHeartbeatPRequest

  job_master.proto:380

  • optional int64 masterId = 1

  • optional JobMasterHeartbeatPOptions options = 2

  message JobMasterHeartbeatPResponse

  job_master.proto:384

  • optional JobMasterMetaCommand command = 1

* This interface contains job master service endpoints for job service workers.

• rpc Heartbeat (JobHeartbeatPRequest, JobHeartbeatPResponse)

  job_master.proto:343

  * Periodic worker heartbeat returns a list of commands for the worker to execute.

  message JobHeartbeatPRequest

  job_master.proto:316

  • optional JobWorkerHealth jobWorkerHealth = 1

  • repeated JobInfo taskInfos = 2

  • optional JobHeartbeatPOptions options = 3

  message JobHeartbeatPResponse

  job_master.proto:321

  • repeated JobCommand commands = 1

• rpc RegisterJobWorker (RegisterJobWorkerPRequest, RegisterJobWorkerPResponse)

  job_master.proto:348

  * Returns a worker id for the given network address.

  message RegisterJobWorkerPRequest

  job_master.proto:326

  • optional WorkerNetAddress workerNetAddress = 1

  • optional RegisterJobWorkerPOptions options = 2

  • optional BuildVersion version = 3

  message RegisterJobWorkerPResponse

  job_master.proto:331

  • optional int64 id = 1

Used in: CancelPRequest

(message has no fields)

Used in: JobCommand

• optional int64 jobId = 1

• optional int64 taskId = 2

Used in: CmdSummary

• repeated JobProgress jobProgress = 1

Used in: GetCmdStatusDetailedResponse

• optional int64 jobControlId = 1

• repeated JobStatusBlock jobStatusBlock = 2

• optional OperationType operationType = 3

• optional int64 jobControlId = 1

• optional OperationType operationType = 2

• optional JobSource jobSource = 3

• optional Status status = 4

• optional int64 submissionTime = 5

• optional int64 duration = 6

• optional string errorMessage = 7

• optional CmdProgress cmdProgress = 8

• optional float progressPercentage = 9

Used in: GetAllMasterStatusPRequest

(message has no fields)

Used in: GetAllWorkerHealthPRequest

(message has no fields)

(message has no fields)

Used in: GetCmdStatusDetailedRequest, GetCmdStatusRequest

(message has no fields)

Used in: GetJobMasterIdPRequest

(message has no fields)

Used in: GetJobServiceSummaryPRequest

(message has no fields)

Used in: GetJobStatusDetailedPRequest

(message has no fields)

Used in: GetJobStatusPRequest

(message has no fields)

Used in: JobHeartbeatPResponse

• optional RunTaskCommand runTaskCommand = 1

• optional CancelTaskCommand cancelTaskCommand = 2

• optional RegisterCommand registerCommand = 3

• optional SetTaskPoolSizeCommand setTaskPoolSizeCommand = 4

Used in: JobHeartbeatPRequest

(message has no fields)

next available id: 14

Used in: GetJobStatusDetailedPResponse, GetJobStatusPResponse, JobHeartbeatPRequest, JobServiceSummary, ListAllPResponse

• optional int64 id = 1

• optional string errorMessage = 2

• optional Status status = 4

• optional int64 lastUpdated = 6

• optional JobType type = 8

• optional bytes result = 9

• optional string errorType = 15

• optional string name = 7

  Some jobs don't have these

• optional int64 parentId = 10

• repeated JobInfo children = 11

• optional string workerHost = 12

• optional string description = 13

• repeated string affectedPaths = 14

• repeated JobUnused unused0 = 3

  Around for backwards compatibility

  formerly taskInfos

• optional string unused1 = 5

  formerly result

Used in: JobMasterHeartbeatPRequest

(message has no fields)

Used in: JobMasterHeartbeatPResponse

• MetaCommand_Unknown = 0

• MetaCommand_Nothing = 1

• MetaCommand_Register = 2

  Ask the standby master to re-register.

Used in: GetAllMasterStatusPResponse

• optional string state = 1

• optional NetAddress masterAddress = 2

• optional int64 startTime = 3

• optional BuildVersion version = 4

Used in: CmdProgress

• optional int64 jobId = 1

• optional int64 fileCount = 2

• optional int64 fileSize = 3

• optional int64 lastUpdateMs = 4

• optional string errorMsg = 5

• optional string errorType = 6

• optional Status status = 7

Used in: GetJobServiceSummaryPResponse

• repeated StatusSummary summaryPerStatus = 1

• repeated JobInfo recentActivities = 2

• repeated JobInfo recentFailures = 3

• repeated JobInfo longestRunning = 4

Used in: CmdSummary

• UNSUPPORTED = 0

• CLI = 1

• POLICY = 2

• SYSTEM = 3

Used in: CmdStatusBlock

• optional int64 jobId = 1

• optional Status jobStatus = 2

• optional string filePath = 3

• optional string filePathFailed = 4

Used in: JobInfo

• PLAN = 1

• TASK = 2

• WORKFLOW = 3

Used in: JobInfo

(message has no fields)

Used in: GetAllWorkerHealthPResponse, JobHeartbeatPRequest

• optional int64 workerId = 1

• repeated double loadAverage = 2

• optional int64 lastUpdated = 3

• optional string hostname = 4

• optional int32 taskPoolSize = 5

• optional int32 numActiveTasks = 6

• optional int32 unfinishedTasks = 7

• optional BuildVersion version = 8

Used in: ListAllPRequest

• repeated Status status = 1

• optional string name = 2

• optional bool jobIdOnly = 3

Used in: CmdStatusBlock, CmdSummary

• DIST_LOAD = 1

• DIST_CP = 2

• PERSIST = 3

Used in: JobCommand

(message has no fields)

Used in: RegisterJobMasterPRequest

• optional int64 startTimeMs = 2

• optional int64 losePrimacyTimeMs = 3

• optional BuildVersion version = 4

Used in: RegisterJobWorkerPRequest

(message has no fields)

Used in: RunPRequest

(message has no fields)

Used in: JobCommand

• optional int64 jobId = 1

• optional int64 taskId = 2

• optional bytes jobConfig = 3

• optional bytes taskArgs = 4

Used in: JobCommand

• optional int32 taskPoolSize = 1

Used in: CmdSummary, GetCmdStatusResponse, JobInfo, JobProgress, JobStatusBlock, ListAllPOptions, StatusSummary, table.TransformJobInfo

• UNKNOWN = 0

• CREATED = 1

• CANCELED = 2

• FAILED = 3

• RUNNING = 4

• COMPLETED = 5

Used in: JobServiceSummary

• optional Status status = 1

• optional int64 count = 2

Used in: SubmitRequest

(message has no fields)