package peloton.api.v0.peloton

Get desktop application:
View/edit binary Protocol Buffers messages

* Change log of an entity info, such as Job config etc.

Used in: job.JobConfig, job.RuntimeInfo, task.RuntimeInfo

• uint64 version = 1

  * Version number of the entity info which is monotonically increasing. Clients can use this to guide against race conditions using MVCC.

• uint64 createdAt = 2

  The timestamp when the entity info is created

• uint64 updatedAt = 3

  The timestamp when the entity info is updated

• string updatedBy = 4

  The user or service that updated the entity info

* A unique ID assigned to offers from a host.

Used in: private.hostmgr.hostsvc.HostOffer, private.hostmgr.hostsvc.LaunchTasksRequest, private.hostmgr.hostsvc.OfferOperationsRequest, private.resmgr.Placement

• string value = 1

* A unique ID assigned to a Job. This is a UUID in RFC4122 format.

Used in: errors.JobGetRuntimeFail, errors.JobNotFound, job.CreateRequest, job.CreateResponse, job.DeleteRequest, job.GetActiveJobsResponse, job.GetCacheRequest, job.GetRequest, job.InvalidJobConfig, job.InvalidJobId, job.JobAlreadyExists, job.JobInfo, job.JobNotFound, job.JobSummary, job.RefreshRequest, job.RestartRequest, job.StartRequest, job.StopRequest, job.UpdateRequest, job.UpdateResponse, job.svc.CreateJobRequest, job.svc.CreateJobResponse, job.svc.DeleteJobRequest, job.svc.GetJobCacheRequest, job.svc.GetJobRequest, job.svc.RefreshJobRequest, job.svc.RestartJobRequest, job.svc.StartJobRequest, job.svc.StopJobRequest, job.svc.UpdateJobRequest, task.BrowseSandboxRequest, task.DeletePodEventsRequest, task.GetCacheRequest, task.GetPodEventsRequest, task.GetRequest, task.InstanceIdOutOfRange, task.ListRequest, task.QueryRequest, task.RefreshRequest, task.RestartRequest, task.StartRequest, task.StopRequest, task.TaskInfo, task.svc.BrowseSandboxRequest, task.svc.GetPodEventsRequest, task.svc.GetTaskCacheRequest, task.svc.GetTaskRequest, task.svc.ListTasksRequest, task.svc.QueryTasksRequest, task.svc.RefreshTasksRequest, task.svc.RestartTasksRequest, task.svc.StartTasksRequest, task.svc.StopTasksRequest, update.UpdateInfo, update.svc.CreateUpdateRequest, update.svc.GetUpdateCacheResponse, update.svc.ListUpdatesRequest, volume.PersistentVolumeInfo, volume.svc.ListVolumesRequest, private.models.UpdateModel, private.resmgr.Task

• string value = 1

* Key, value pair used to store free form user-data.

Used in: host.HostInfo, job.JobConfig, job.JobSummary, job.QuerySpec, task.GetCacheResponse, task.LabelConstraint, task.TaskConfig, private.models.ConfigAddOn

• string key = 1

• string value = 2

* Opaque data passed to Peloton from the client.

Used in: update.UpdateInfo, update.svc.AbortUpdateRequest, update.svc.CreateUpdateRequest, update.svc.PauseUpdateRequest, update.svc.ResumeUpdateRequest, private.models.UpdateModel

• string data = 1

* A unique ID assigned to a Resource Pool. This is a UUID in RFC4122 format.

Used in: errors.InvalidRespool, job.JobConfig, job.JobSummary, job.QueryRequest, respool.CreateResourcePoolRequest, respool.CreateResourcePoolResponse, respool.CreateResponse, respool.DeleteResourcePoolRequest, respool.GetRequest, respool.GetResourcePoolRequest, respool.InvalidResourcePoolConfig, respool.LookupResourcePoolIDResponse, respool.LookupResponse, respool.ResourcePoolAlreadyExists, respool.ResourcePoolConfig, respool.ResourcePoolInfo, respool.ResourcePoolIsBusy, respool.ResourcePoolIsNotLeaf, respool.ResourcePoolNotDeleted, respool.ResourcePoolNotFound, respool.UpdateRequest, respool.UpdateResourcePoolRequest, private.resmgr.EnqueueGangsRequest, private.resmgr.GetPendingTasksRequest, private.resmgr.ResourcePoolNoPermission, private.resmgr.ResourcePoolNotFound

• string value = 1

* Secret is used to store secrets per job and contains ID, absolute container mount path and base64 encoded secret data

Used in: job.CreateRequest, job.GetResponse, job.UpdateRequest, job.svc.CreateJobRequest, job.svc.GetJobResponse, job.svc.UpdateJobRequest

• optional SecretID id = 1

  UUID of the secret

• string path = 2

  Path at which the secret file will be mounted in the container

• optional Secret.Value value = 3

  Secret value

Used in: Secret

• bytes data = 1

  Secret data as byte array

* A unique ID assigned to a Secret. This is a UUID in RFC4122 format.

Used in: Secret

• string value = 1

* A unique ID assigned to a Task (aka job instance). The task ID is in the format of JobID-<InstanceID>.

Used in: task.TaskEvent, task.svc.PodEvent, private.hostmgr.hostsvc.FilterHint.Host, private.hostmgr.hostsvc.GetHostsByQueryResponse.Host, private.hostmgr.hostsvc.KillAndReserveTasksRequest.Entry, private.hostmgr.hostsvc.LaunchableTask, private.hostmgr.hostsvc.ReleaseHostsHeldForTasksRequest, private.resmgr.KillTasksError, private.resmgr.KillTasksRequest, private.resmgr.Placement.Task, private.resmgr.PreemptionCandidate, private.resmgr.Task, private.resmgr.TasksNotFound, private.resmgr.UpdateTasksStateRequest.UpdateTaskStateEntry

• string value = 1

* Time range specified by min and max timestamps. Time range is left closed and right open: [min, max)

Used in: job.QuerySpec

• optional google.protobuf.Timestamp min = 1

• optional google.protobuf.Timestamp max = 2

* A unique ID assigned to a update.

Used in: job.RestartResponse, job.RuntimeInfo, job.StartResponse, job.StopResponse, job.svc.RestartJobResponse, job.svc.StartJobResponse, job.svc.StopJobResponse, update.UpdateInfo, update.svc.AbortUpdateRequest, update.svc.CreateUpdateResponse, update.svc.GetUpdateCacheRequest, update.svc.GetUpdateRequest, update.svc.PauseUpdateRequest, update.svc.ResumeUpdateRequest, update.svc.RollbackUpdateRequest, private.models.UpdateModel

• string value = 1

* A unique ID assigned to a Volume. This is a UUID in RFC4122 format.

Used in: task.RuntimeInfo, volume.PersistentVolumeInfo, volume.svc.DeleteVolumeRequest, volume.svc.GetVolumeRequest, private.hostmgr.hostsvc.Volume

• string value = 1