package com.nus.dbsystem.falcon.v0

Get desktop application:
View/edit binary Protocol Buffers messages

Message for creating a model serving service

• int32 serving_id = 1

  the serving service id

• string serving_name = 2

  the serving service name

• int32 model_id = 3

  the model id bind with the serving service

• int32 party_id = 4

  the party id of the initiator

Response of CreateServingRequest

• int32 serving_id = 1

• int32 is_success = 2

• int32 error_code = 3

• string error_msg = 4

Message for deleting a serving service

• int32 serving_id = 1

• int32 party_id = 2

Response of DeleteServingResponse

• int32 serving_id = 1

• int32 is_success = 2

• int32 error_code = 3

• string error_msg = 4

Message for stopping a serving service

• int32 serving_id = 1

• int32 party_id = 2

Response of StopServingResponse

• int32 serving_id = 1

• int32 is_success = 2

• int32 error_code = 3

• string error_msg = 4

Message for enabling a serving service

• int32 serving_id = 1

• int32 model_id = 2

• int32 party_id = 3

Response of EnableServingRequest

• int32 serving_id = 1

• int32 is_success = 2

• int32 error_code = 3

• string error_msg = 4

Message sent to the coordinator

• optional HeartBeat heartbeat = 1

  heartbeat message is required

• repeated JobStatus jobs = 2

  add JobStatus if any job is executing or just finished

Message for forwarding a job to executors

• int32 job_id = 1

  new job id

• string job_name = 2

  job name

• int32 task_num = 3

  task number in the job

• int32 party_num = 4

  participating party number

• repeated int32 party_ids = 5

  participating party ids

• int32 fl_setting = 6

  setting: 0, vertical fl; 1, horizontal fl

• optional google.protobuf.Value job_desc = 7

  job description with (key, value) format

Response of ForwardJobRequest

• int32 job_id = 1

  received job id

• int32 is_success = 2

  whether the job is received and executed

• int32 error_code = 3

  error code

• string error_msg = 4

  error msg

Message for executors to report heartbeat to the coordinator

Used in: ExecutorStatus

• optional google.protobuf.Timestamp timestamp = 1

  record the google timestamp

Message for reporting status of a job

Used in: ExecutorStatus

• int32 job_id = 1

  job id

• StatusType job_status = 2

  job status

• string job_result = 3

  job result

• int32 error_code = 4

  error code

• string error_msg = 5

  error msg

• repeated TaskStatus tasks = 6

  each task status

This message is from the coordinator to executor for publishing a trained model to model serving stage

• int32 model_id = 1

  trained model id

• int32 initiator_party_id = 2

  initiator party id

This message is for the response of ModelPublish

• int32 model_id = 1

  trained model id

• int32 initiator_party_id = 2

  initiator party id

• int32 is_success = 3

  model publish status

• int32 error_code = 4

  error code

• string error_msg = 5

  error msg

This message denotes the phe public key and private key share (i.e., auth server)

• int32 public_key_s = 1

  public key info

• int32 public_key_w = 2

• int32 public_key_l = 3

• repeated string public_key_n = 4

• string public_key_g = 5

• string public_key_delta = 6

• int32 auth_server_i = 7

  private key share

• string auth_server_si = 8

Message for querying serving service

• repeated int32 serving_id = 1

• int32 party_id = 2

Response of QueryServingResponse

• repeated ServingInfo serving_infos = 1

Existing serving information

Used in: QueryServingResponse

• int32 serving_id = 1

• int32 served_model_id = 2

• ServingStatus status = 3

the status of model serving service

Used in: ServingInfo

• created = 0

  the service is created but no model bind

• online = 1

  the service is bind with a model and is in serving

• offline = 2

  the service is bind with a model but is not in serving

job or task status

Used in: JobStatus, TaskStatus

• initialized = 0

  the job or task is initialized but not running

• running = 1

  the job or task is running

• succeed = 2

  the job or task is finished

• failed = 3

  the job or task is failed

Message for stopping a job

• int32 job_id = 1

  job id

Response of StopJobRequest

• int32 job_id = 1

  job id

• int32 is_success = 2

  whether job is stopped

• int32 error_code = 3

  error code

• string error_msg = 4

  error msg

Message for reporting status of each task

Used in: JobStatus

• int32 task_id = 1

  task id

• StatusType task_status = 2

  task status

• string task_result = 3

  task result

• int32 error_code = 4

  error code

• string error_msg = 5

  error msg

Message for updating a serving model

• int32 serving_id = 1

• int32 new_model_id = 2

• int32 party_id = 3

Response of UpdateServingRequest

• int32 serving_id = 1

• int32 is_success = 2

• int32 error_code = 3

• string error_msg = 4