package peloton.api.v1alpha.peloton

Get desktop application:
View/edit binary Protocol Buffers messages

An opaque token associated with an entity object used to implement optimistic concurrency control. For API taking EntityVersion, it would return an yarpc error with CodeAborted and message "unexpected entity version", if the entity version provided does not match the internal version of the entity affected (i.e. there is a write-after-read confliect), unless otherwise specified. Upon receiving the error, caller is expected to read the entity status and its entity version again, and re-perform the operation if needed.

Used in: job.stateless.JobStatus, job.stateless.WorkflowStatus, job.stateless.svc.AbortJobWorkflowRequest, job.stateless.svc.AbortJobWorkflowResponse, job.stateless.svc.CreateJobResponse, job.stateless.svc.DeleteJobRequest, job.stateless.svc.GetJobRequest, job.stateless.svc.GetReplaceJobDiffRequest, job.stateless.svc.PatchJobRequest, job.stateless.svc.PatchJobResponse, job.stateless.svc.PauseJobWorkflowRequest, job.stateless.svc.PauseJobWorkflowResponse, job.stateless.svc.ReplaceJobRequest, job.stateless.svc.ReplaceJobResponse, job.stateless.svc.RestartJobRequest, job.stateless.svc.RestartJobResponse, job.stateless.svc.ResumeJobWorkflowRequest, job.stateless.svc.ResumeJobWorkflowResponse, job.stateless.svc.StartJobRequest, job.stateless.svc.StartJobResponse, job.stateless.svc.StopJobRequest, job.stateless.svc.StopJobResponse, pod.PodEvent, pod.PodStatus

• string value = 1

A unique ID assigned to offers from a host.

• string value = 1

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

Used in: job.stateless.JobInfo, job.stateless.JobSummary, job.stateless.svc.AbortJobWorkflowRequest, job.stateless.svc.CreateJobRequest, job.stateless.svc.CreateJobResponse, job.stateless.svc.DeleteJobRequest, job.stateless.svc.GetJobCacheRequest, job.stateless.svc.GetJobIDFromJobNameResponse, job.stateless.svc.GetJobRequest, job.stateless.svc.GetReplaceJobDiffRequest, job.stateless.svc.GetWorkflowEventsRequest, job.stateless.svc.ListJobWorkflowsRequest, job.stateless.svc.ListPodsRequest, job.stateless.svc.PatchJobRequest, job.stateless.svc.PauseJobWorkflowRequest, job.stateless.svc.QueryPodsRequest, job.stateless.svc.RefreshJobRequest, job.stateless.svc.ReplaceJobRequest, job.stateless.svc.RestartJobRequest, job.stateless.svc.ResumeJobWorkflowRequest, job.stateless.svc.StartJobRequest, job.stateless.svc.StopJobRequest, volume.svc.ListVolumesRequest, watch.PodFilter, watch.StatelessJobFilter, watch.svc.WatchResponse, private.jobmgr.GetInstanceAvailabilityInfoForJobRequest, private.jobmgr.GetJobCacheRequest, private.jobmgr.QueryJobCacheResponse.JobCache, private.jobmgr.RefreshJobRequest

• string value = 1

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

Used in: host.HostInfo, host.HostSummary, job.stateless.JobSpec, job.stateless.JobSummary, job.stateless.QuerySpec, pod.LabelConstraint, pod.PodSpec, pod.svc.GetPodCacheResponse, watch.PodFilter, watch.StatelessJobFilter, private.jobmgr.QueryJobCacheRequest.CacheQuerySpec

• string key = 1

• string value = 2

Opaque data passed to Peloton from the client. Passing an empty string in the structure will unset the existing data.

Used in: job.stateless.WorkflowInfo, job.stateless.svc.AbortJobWorkflowRequest, job.stateless.svc.CreateJobRequest, job.stateless.svc.PatchJobRequest, job.stateless.svc.PauseJobWorkflowRequest, job.stateless.svc.ReplaceJobRequest, job.stateless.svc.RestartJobRequest, job.stateless.svc.ResumeJobWorkflowRequest

• string data = 1

A unique ID assigned to a pod. It should be treated as an opaque token.

Used in: pod.PodEvent, pod.PodStatus, pod.svc.BrowsePodSandboxRequest, pod.svc.DeletePodEventsRequest, pod.svc.GetPodEventsRequest, private.hostmgr.v1alpha.hostmgr.FilterHint.Host, private.hostmgr.v1alpha.hostmgr.LaunchablePod, private.hostmgr.v1alpha.svc.KillAndHoldPodsRequest.Entry, private.hostmgr.v1alpha.svc.KillPodsRequest

• string value = 1

A unique name assigned to a pod. By default, the pod name is in the format of JobID-<InstanceID>.

Used in: pod.PodSpec, pod.PodSummary, pod.QuerySpec, pod.svc.BrowsePodSandboxRequest, pod.svc.DeletePodEventsRequest, pod.svc.GetPodCacheRequest, pod.svc.GetPodEventsRequest, pod.svc.GetPodRequest, pod.svc.RefreshPodRequest, pod.svc.RestartPodRequest, pod.svc.StartPodRequest, pod.svc.StopPodRequest, volume.PersistentVolumeInfo, watch.PodFilter, watch.svc.WatchResponse, private.jobmgr.GetThrottledPodsResponse

• string value = 1

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

Used in: job.stateless.JobSpec, job.stateless.JobSummary, respool.CreateResourcePoolRequest, respool.CreateResourcePoolResponse, respool.DeleteResourcePoolRequest, respool.GetResourcePoolRequest, respool.LookupResourcePoolIDResponse, respool.ResourcePoolInfo, respool.ResourcePoolSpec, respool.UpdateResourcePoolRequest

• string value = 1

Resources describe the resources on a host.

Used in: host.HostSummary

• double cpu = 1

  Number of CPU cores.

• double memMb = 2

  Memory in MB.

• double diskMb = 3

  Disk in MB.

• double gpu = 4

  Number of GPU cores.

Revision of an entity info, such as JobSpec etc.

Used in: job.stateless.JobSpec, job.stateless.JobStatus, pod.PodStatus, respool.ResourcePoolSpec

• 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 created_at = 2

  The timestamp when the entity info is created.

• uint64 updated_at = 3

  The timestamp when the entity info is updated.

• string updated_by = 4

  The user or service that updated the entity info.

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

Used in: job.stateless.svc.CreateJobRequest, job.stateless.svc.GetJobResponse, job.stateless.svc.PatchJobRequest, job.stateless.svc.ReplaceJobRequest

• optional SecretID secret_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

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

Used in: job.stateless.QuerySpec

• optional google.protobuf.Timestamp min = 1

• optional google.protobuf.Timestamp max = 2

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

Used in: pod.PodStatus, volume.PersistentVolumeInfo, volume.svc.DeleteVolumeRequest, volume.svc.GetVolumeRequest

• string value = 1