package peloton.api.v0.update.svc

Get desktop application:
View/edit binary Protocol Buffers messages

* Update service interface EXPERIMENTAL: This API is not yet stable.

• rpc CreateUpdate (CreateUpdateRequest, CreateUpdateResponse)

  update_svc.proto:24

  Create a new update for a job. Only one update can exist for a job at a given time.

  message CreateUpdateRequest

  update_svc.proto:52

  * Request message for UpdateService.CreateUpdate method.

  • optional peloton.JobID jobId = 1

    Entity id of the job to be updated.

  • optional job.JobConfig jobConfig = 2

    New configuration of the job to be updated. The new job config will be applied to all instances without violating the job SLA.

  • optional UpdateConfig updateConfig = 3

    The options of the update.

  • optional peloton.OpaqueData opaque_data = 4

    Opaque data supplied by the client

  message CreateUpdateResponse

  update_svc.proto:73

  * Response message for UpdateService.CreateUpdate method. Returns errors: NOT_FOUND: if the job with the provided identifier is not found. INVALID_ARGUMENT: if the provided job config or update config is invalid.

  • optional peloton.UpdateID updateID = 1

    Identifier for the newly created update.

• rpc GetUpdate (GetUpdateRequest, GetUpdateResponse)

  update_svc.proto:27

  Get the status of an update.

  message GetUpdateRequest

  update_svc.proto:81

  * Request message for UpdateService.GetUpdate method.

  • optional peloton.UpdateID updateId = 1

  • bool statusOnly = 2

    If set, only return the update status in the response.

  message GetUpdateResponse

  update_svc.proto:92

  * Response message for UpdateService.GetUpdate method. Returns errors: INVALID_ARGUMENT: if the update ID is not provided.

  • optional UpdateInfo updateInfo = 1

    Update information.

• rpc ListUpdates (ListUpdatesRequest, ListUpdatesResponse)

  update_svc.proto:31

  List all updates (including current and previously completed) for a given job.

  message ListUpdatesRequest

  update_svc.proto:100

  * Request message for UpdateService.ListUpdates method.

  • int32 limit = 1

    Number of updates to return. Not supported.

  • optional peloton.JobID jobID = 2

    Updates will be returned for the given job identifier.

  message ListUpdatesResponse

  update_svc.proto:112

  * Response message for UpdateService.ListUpdates method. Returns errors: INVALID_ARGUMENT: if the job ID is not provided.

  • repeated UpdateInfo updateInfo = 1

• rpc PauseUpdate (PauseUpdateRequest, PauseUpdateResponse)

  update_svc.proto:34

  Pause an update.

  message PauseUpdateRequest

  update_svc.proto:119

  * Request message for UpdateService.PauseUpdate method.

  • optional peloton.UpdateID updateId = 1

    Identifier of the update to be paused.

  • optional peloton.OpaqueData opaque_data = 2

    Opaque data supplied by the client

  message PauseUpdateResponse

  update_svc.proto:133

  * Response message for UpdateService.PauseUpdate method. Returns errors: NOT_FOUND: if the update with the provided identifier is not found. UNAVAILABLE: if the update is in a state which cannot be paused.

  (message has no fields)

• rpc ResumeUpdate (ResumeUpdateRequest, ResumeUpdateResponse)

  update_svc.proto:37

  Resume a paused update.

  message ResumeUpdateRequest

  update_svc.proto:139

  * Request message for UpdateService.ResumeUpdate method.

  • optional peloton.UpdateID updateId = 1

    Identifier of the update to be resumed.

  • optional peloton.OpaqueData opaque_data = 2

    Opaque data supplied by the client

  message ResumeUpdateResponse

  update_svc.proto:153

  * Response message for UpdateService.ResumeUpdate method. Returns errors: NOT_FOUND: if the update with the provided identifier is not found. UNAVAILABLE: if the update is in a state which cannot be resumed.

  (message has no fields)

• rpc RollbackUpdate (RollbackUpdateRequest, RollbackUpdateResponse)

  update_svc.proto:40

  Rollback an update.

  message RollbackUpdateRequest

  update_svc.proto:159

  * Request message for UpdateService.RollbackUpdate method.

  • optional peloton.UpdateID updateId = 1

    Identifier of the update to be rolled back.

  message RollbackUpdateResponse

  update_svc.proto:170

  * Response message for UpdateService.RollbackUpdate method. Returns errors: NOT_FOUND: if the update with the provided identifier is not found. UNAVAILABLE: if the update is in a state which cannot be resumed.

  (message has no fields)

• rpc AbortUpdate (AbortUpdateRequest, AbortUpdateResponse)

  update_svc.proto:43

  Abort an update.

  message AbortUpdateRequest

  update_svc.proto:176

  * Request message for UpdateService.AbortUpdate method.

  • optional peloton.UpdateID updateId = 1

    Identifier of the update to be aborted.

  • bool softAbort = 2

  • optional peloton.OpaqueData opaque_data = 3

    Opaque data supplied by the client

  message AbortUpdateResponse

  update_svc.proto:191

  * Response message for UpdateService.AbortUpdate method. Returns errors: NOT_FOUND: if the update with the provided identifier is not found. UNAVAILABLE: if the update is in a state which cannot be resumed.

  (message has no fields)

• rpc GetUpdateCache (GetUpdateCacheRequest, GetUpdateCacheResponse)

  update_svc.proto:46

  Debug only method. Get the cache of a job update.

  message GetUpdateCacheRequest

  update_svc.proto:197

  * Request message for UpdateService.GetUpdateCache method.

  • optional peloton.UpdateID updateId = 1

  message GetUpdateCacheResponse

  update_svc.proto:206

  * Response message for UpdateService.GetUpdateCache method. Returns errors: INVALID_ARGUMENT: if the update ID is not provided.

  • optional peloton.JobID jobId = 1

    Job ID of the job update

  • State state = 2

    The state of the job update

  • repeated uint32 instancesTotal = 3

    List of instances which will be updated with this update

  • repeated uint32 instancesDone = 4

    List of instances which have already been updated

  • repeated uint32 instancesCurrent = 5

    List of instances which are currently being updated

  • repeated uint32 instancesAdded = 6

    List of instances which have been added with this update

  • repeated uint32 instancesUpdated = 7

    List of existing instances which need to be updated with this update

  • repeated uint32 instancesFailed = 8

    List of existing instances which fail to be updated with this update