Default package

Get desktop application:
View/edit binary Protocol Buffers messages

• rpc Create (CreateRequest, CreateResponse)

  resource_service.proto:201

  message CreateRequest

  resource_service.proto:71

  • optional Resource resource = 1

  message CreateResponse

  resource_service.proto:75

  • optional Resource resource = 1

• rpc Delete (DeleteRequest, DeleteResponse)

  resource_service.proto:202

  message DeleteRequest

  resource_service.proto:79

  • string resourceKind = 1

  • string resourceName = 2

  message DeleteResponse

  resource_service.proto:84

  (message has no fields)

• rpc DeleteList (DeleteListRequest, DeleteListResponse)

  resource_service.proto:203

  message DeleteListRequest

  resource_service.proto:87

  • string resourceKind = 1

  message DeleteListResponse

  resource_service.proto:91

  (message has no fields)

• rpc Replace (ReplaceRequest, ReplaceResponse)

  resource_service.proto:204

  message ReplaceRequest

  resource_service.proto:94

  • optional Resource resource = 1

  • int64 resourceVersion = 2

  message ReplaceResponse

  resource_service.proto:99

  • optional Resource resource = 1

• rpc Patch (PatchRequest, PatchResponse)

  resource_service.proto:205

  message PatchRequest

  resource_service.proto:103

  • optional Resource resource = 1

  • int64 resourceVersion = 2

  message PatchResponse

  resource_service.proto:108

  • optional Resource resource = 1

• rpc Get (GetRequest, GetResponse)

  resource_service.proto:207

  message GetRequest

  resource_service.proto:112

  • string resourceKind = 1

  • string resourceName = 2

  • optional ReadOptions options = 3

  message GetResponse

  resource_service.proto:118

  • optional Resource resource = 1

• rpc List (ListRequest, ListResponse)

  resource_service.proto:208

• rpc ListByFilter (ListRequest, ListResponse)

  resource_service.proto:209

• rpc ListByFilterNot (ListRequest, ListResponse)

  resource_service.proto:210

• rpc Watch (stream WatchRequest, stream WatchResponse)

  resource_service.proto:211

  message WatchRequest

  resource_service.proto:153

  • WatchOp watchOp = 1

  • string resourceKind = 2

  • string resourceName = 3

  message WatchResponse

  resource_service.proto:159

  • optional WatchEvent watchEvent = 1

• rpc WatchList (stream WatchListRequest, stream WatchListResponse)

  resource_service.proto:212

  message WatchListRequest

  resource_service.proto:163

  • WatchOp watchOp = 1

  • string resourceKind = 2

  message WatchListResponse

  resource_service.proto:168

  • optional WatchEvent watchEvent = 1

• rpc GetStatus (GetStatusRequest, GetStatusResponse)

  resource_service.proto:214

  message GetStatusRequest

  resource_service.proto:172

  • string resourceKind = 1

  • string resourceName = 2

  • optional ReadOptions options = 3

  message GetStatusResponse

  resource_service.proto:178

  • optional Resource resource = 1

• rpc ReplaceStatus (ReplaceStatusRequest, ReplaceStatusResponse)

  resource_service.proto:215

  message ReplaceStatusRequest

  resource_service.proto:182

  • optional Resource resource = 1

  • int64 resourceVersion = 2

  message ReplaceStatusResponse

  resource_service.proto:187

  • optional Resource resource = 1

• rpc PatchStatus (PatchStatusRequest, PatchStatusResponse)

  resource_service.proto:216

  message PatchStatusRequest

  resource_service.proto:191

  • optional Resource resource = 1

  • int64 resourceVersion = 2

  message PatchStatusResponse

  resource_service.proto:196

  • optional Resource resource = 1

• optional StateStore state_store = 1

Used in: ExitCodeFailoverPolicy, FailoverPolicy

• RestartType restartType = 1

• MaxFailurePolicy maxFailurePolicy = 2

• int32 maxFailureTimes = 3

Used in: JobStatus

• string type = 1

  Type of condition.

• string reason = 2

  The reason for the condition's last transition.

• string message = 3

  A human readable message indicating details about the transition.

• int64 lastTransitionTime = 4

  Last time the condition transitioned from one status to another.

• int64 lastUpdateTime = 5

  The last time this condition was updated.

• optional NodeSkipHighLoadContent nodeSkipHighLoadContent = 1

• optional NodeSatisfyAttributesContent nodeSatisfyAttributesContent = 2

• optional NodeQuotaUsageAverageContent nodeQuotaUsageAverageContent = 3

• optional NodeGpuAffinityContent nodeGpuAffinityContent = 5

  NodeLocalityContent nodeLocalityContent = 4;

• optional NodeNicPolicyContent nodeNicPolicyContent = 6

• optional NodeInterAppSameRoleToleranceContent nodeInterAppSameRoleToleranceContent = 7

• optional NodeInnerAppSameRoleToleranceContent nodeInnerAppSameRoleToleranceContent = 8

Used in: ExecutorSpec

• optional google.protobuf.Int32Value port_register_num = 1

Used in: UpdatePolicy

(message has no fields)

Used in: SchedulePolicy

• optional UpdatePolicy updatePolicy = 1

Used in: ScheduleStrategy

• float extend_mem_ratio = 1

• int64 extend_mem_size = 2

• int64 max_mem_size = 3

• int64 min_mem_size = 4

Used in: InputPolicy

(message has no fields)

Used in: RoleSpec

• int32 roleIndex = 1

  System provided

• repeated ResourceRequest resourceRequests = 2

  User provided

• string javaOpts = 3

• string command = 4

• map<string, string> envs = 5

• optional InputPolicy inputPolicy = 6

• bool isEvaluation = 8

  Forward compatibility, may be deprecated in future

• optional WorkerSpec worker_spec_template = 10

• optional ConsulConfig consul_config = 11

• optional PluginConfig plugin_config = 12

• int64 startTime = 1

• int64 completionTime = 2

• string state = 3

• int32 exitStatus = 4

• string diagnostics = 5

• repeated string networkSockets = 6

• map<string, string> metrics = 7

• string hostname = 8

Used in: FailoverPolicy

• repeated int32 retryableExitCodes = 1

• optional CommonFailoverPolicy commonFailoverPolicy = 2

Used in: RoleSpec

• oneof failoverPolicy

  • CommonFailoverPolicy commonFailoverPolicy = 1

  • ExitCodeFailoverPolicy exitCodeFailoverPolicy = 2

Used in: SchedulePolicy

• optional UpdatePolicy updatePolicy = 1

Used in: ExecutorSpec

• oneof inputPolicy

  • EnvInputPolicy envInputPolicy = 1

  • StreamingInputPolicy streamingInputPolicy = 2

• map<string, RoleSpec> roleSpecs = 1

• int64 startTime = 1

• int64 completionTime = 2

• map<string, RoleStatus> roleStatuses = 3

• repeated Condition conditions = 5

Used in: UpdatePolicy

(message has no fields)

Used as request type in: ResourceService.List, ResourceService.ListByFilter, ResourceService.ListByFilterNot

• string resourceKind = 1

• optional ReadOptions options = 2

• map<string, string> queryParameters = 3

Used as response type in: ResourceService.List, ResourceService.ListByFilter, ResourceService.ListByFilterNot

• repeated Resource resources = 1

Used in: CommonFailoverPolicy

• FAIL_APP = 0

• FAIL_ATTEMPT = 1

• NONE = 2

Used in: Resource

• string name = 1

  Name must be unique within a resource. Is required when creating resources. E.g. ps/worker/chief if Role is a resource.

• int64 version = 2

  An opaque value that represents the internal version of this object that can be used by clients to determine when objects have changed. May be used for optimistic concurrency, change detection, and the watch operation on a resource or set of resources.

• int64 creationTime = 3

• int64 deletionTime = 4

• int64 uid = 5

• repeated OwnerRef ownerRefs = 6

  List of objects depended by this object.

• map<string, int64> black_list = 1

• bool is_black_list_updated = 1

Used in: ConstraintContent

• NodeGpuAffinityContent.GPUAllocationType gpuAllocationType = 1

• string affinityRequirement = 2

Used in: NodeGpuAffinityContent

• ALL_INSERTABLE_POSITIONS = 0

  random allocate

• CONTINUOUS_POSITIONS = 1

  continuous position allocate

• MAXIMUM_DATA_TRANSMISSION_RATE = 2

  network card affinity, not support yet

Used in: ConstraintContent

• map<string, int32> inner_app_roles_tolerance = 1

  {roleName: tolerance number}

Used in: ConstraintContent

• map<string, int32> inter_app_roles_tolerance = 1

  {roleName: tolerance number}

Used in: ConstraintContent

• NodeNicPolicyContent.NicPolicy nicPolicy = 1

Used in: NodeNicPolicyContent

• NIC_HOST = 0

• NIC_FAST = 1

• NIC_NUMA = 2

• NIC_ALL = 3

Used in: ConstraintContent

• string resourceInformation = 1

Used in: ConstraintContent

• string nodeAttributeExpression = 1

Used in: ConstraintContent

• float load = 1

Used in: Meta

• string kind = 1

  Resource kind.

• string name = 2

  Resource name, that is name in Meta.

• int64 uid = 3

  Resource uid, that is uid in Meta.

Used in: PluginConfig

• string name = 1

• string version = 2

• map<string, string> parameter = 3

Used in: ExecutorSpec

• repeated Plugin basic_plugins = 1

• repeated Plugin extend_plugins = 2

• repeated Plugin disabled_plugins = 3

Used in: GetRequest, GetStatusRequest, ListRequest

• ResourceVersionMatch resourceVersionMatch = 1

• int64 resourceVersion = 2

Used in: CreateRequest, CreateResponse, GetResponse, GetStatusResponse, ListResponse, PatchRequest, PatchResponse, PatchStatusRequest, PatchStatusResponse, ReplaceRequest, ReplaceResponse, ReplaceStatusRequest, ReplaceStatusResponse, WatchEvent

• string kind = 1

  Kind is a string value representing the resource this object represents. Servers may infer this from the endpoint the client submits requests to. Different resource kind has different spec/status message type. Cannot be updated. In CamelCase.

• optional Meta meta = 2

• optional google.protobuf.Any spec = 3

• optional google.protobuf.Any status = 4

Used in: ExecutorSpec

• ResourceType resourceType = 1

• int32 value = 2

• repeated ValueRange valueRanges = 3

Used in: ResourceRequest

• VCORES = 0

• MEMORY_MB = 1

• GPU = 2

• PORT = 3

• TPU_V3_BASE = 4

• TPU_V3_POD = 5

Used in: ReadOptions

• LATEST = 0

• EXACT = 1

Used in: CommonFailoverPolicy

• ON_FAILURE = 0

• NEVER = 1

• ALWAYS = 2

Used in: JobSpec

• int32 replicas = 1

• int32 minReplicas = 2

• optional ExecutorSpec executorSpecTemplate = 3

• optional SchedulePolicy schedulePolicy = 4

• optional FailoverPolicy failoverPolicy = 5

• optional SuccessPolicy successPolicy = 6

• optional YarnScheduler role_scheduler = 8

• optional ScheduleStrategy schedule_strategy = 9

Used in: JobStatus

• int32 activeNum = 1

• int32 succeedNum = 2

• int32 failedNum = 3

Used in: UpdatePolicy

(message has no fields)

Used in: RoleSpec

• oneof schedulePolicy

  • GangSchedulePolicy gangSchedulePolicy = 1

  • DynamicSchedulePolicy dynamicSchedulePolicy = 2

Used in: RoleSpec

• int32 max_replicas_per_node = 1

• int32 executor_delay_start_seconds = 2

• optional ElasticResource elastic_resource = 3

• ScheduleStrategy.RoleCategory role_category = 4

Used in: ScheduleStrategy

• UNKNOWN = 0

• PS = 1

• WORKER = 2

Used in: ApiServerConf

• oneof state_store

  • StateStore.LocalStateStore local_state_store = 1

  • StateStore.NasStateStore nas_state_store = 2

Used in: StateStore

(message has no fields)

Used in: StateStore

• string volume = 1

Used in: InputPolicy

• string dataStream = 2

Used in: RoleSpec

• float successPercent = 1

Used in: DynamicSchedulePolicy, GangSchedulePolicy

• oneof updatePolicy

  • RollingUpdatePolicy rollingUpdatePolicy = 1

  • KillFirstUpdatePolicy killFirstUpdatePolicy = 2

  • CreateFirstUpdatePolicy createFirstUpdatePolicy = 3

Used in: ResourceRequest

• int32 begin = 1

• int32 end = 2

Used in: WatchListResponse, WatchResponse

• WatchEvent.Type type = 1

• optional Resource oldResource = 2

  Resource is: the old state of the resource for Type of MODIFIED the new state of the resource for Type of ADDED, DELETED, MODIFIED

• optional Resource newResource = 3

Used in: WatchEvent

• ADDED = 0

• DELETED = 1

• MODIFIED = 2

Used in: WatchListRequest, WatchRequest

• CREATE = 0

• CANCEL = 1

Used in: ExecutorSpec

• map<string, google.protobuf.Any> specs = 1

(message has no fields)

Used in: RoleSpec

• oneof scheduler

  • YarnScheduler.FairScheduler fair_scheduler = 1

  • YarnScheduler.GangScheduler gang_scheduler = 2

  • YarnScheduler.BatchScheduler batch_scheduler = 3

• YarnScheduler.YarnResourceType resource_type = 4

• YarnScheduler.YarnSchedulingType scheduling_type = 5

• YarnScheduler.YarnGlobalConstraintType global_constraint_type = 6

• YarnScheduler.YarnNeedGlobalNodesView need_global_nodes_view = 7

• optional YarnScheduler.NetworkConfig network_config = 8

Used in: YarnScheduler

• bool set_resource_type_by_hard_constraint = 1

Used in: YarnScheduler

(message has no fields)

Used in: YarnScheduler

• int32 max_retry_num = 1

• int64 max_wait_seconds = 2

Used in: YarnScheduler

• NetworkType network_type = 1

• bool keep_ip_port_under_overlay = 2

Used in: NetworkConfig

• DEFAULT = 0

• OVERLAY = 1

Used in: YarnScheduler

• SOFT_CONSTRAINT = 0

• HARD_CONSTRAINT = 1

Used in: YarnScheduler

• FALSE = 0

• TRUE = 1

Used in: YarnScheduler

• NR_NORMAL = 0

• NR_GUARANTEED = 1

• NR_BEST_EFFORT = 2

Used in: YarnScheduler

• ASYNC = 0

• SYNC = 1