Expand description
sdk/pluginapi request and response schemas, field for field. Wire names are the Go
field names unless Go declares a json tag. Host-only members (HTTPClient, handler
interfaces) are not part of the wire format and are left out.
Structs§
- Auth
Data - Auth
Login Poll Request - Auth
Login Poll Response - Auth
Login Start Request - Auth
Login Start Response - Auth
Model Request - Auth
Parse Request - Auth
Parse Response - Auth
Refresh Request - Auth
Refresh Response - Command
Line Execution Request - Command
Line Execution Response - Command
Line Flag - Command
Line Flag Value - Command
Line Registration Request - Command
Line Registration Response - Config
Field - Executor
Http Request - Executor
Http Response - Executor
Request - Executor
Response - Executor
Stream Chunk pluginapi.ExecutorStreamChunk; seeHttpStreamChunkforErr.- Frontend
Auth Request - Frontend
Auth Response - Host
Affinity Lookup Request - Host
Affinity Lookup Response - Host
Auth File Entry - Host
Auth GetRequest - Host
Auth GetResponse - Host
Auth GetRuntime Response - Host
Auth Save Request - Host
Auth Save Response - Host
Config Summary - Host
Model Execution Request - Host
Model Execution Response - Host
Model Stream Close Request - Host
Model Stream Read Request - Host
Model Stream Read Response - Host
Model Stream Response - Host
Recent Request Entry - Http
Request - Http
Response - Http
Stream Chunk pluginapi.HTTPStreamChunk.Erris a Goerrorinterface: it encodes as{}ornulland never decodes back, so only the payload crosses the wire.- Http
Wire Profile - Management
Registration Request - Management
Registration Response - The
management.registerresult (rpcManagementRegistrationResponse). - Management
Request - Management
Response - Management
Route pluginapi.ManagementRoutewithout its host-sideHandler.- Model
Alias - Model
Info - Model
Registration Request - Model
Registration Response - Model
Response - Model
Route Request - Model
Route Response - Payload
Response - Plugin
Metadata pluginapi.Metadata.- Quota
Bucket - Quota
Bucket Alt - Quota
Describe Request - Quota
Describe Response - Quota
Fetch Request - Quota
Fetch Response - Quota
Fetch Response Alt - Quota
Group - Quota
Group Alt - Quota
Metric - Quota
Reset Request - Quota
Reset Response - Quota
Subscription - Quota
Subscription Alt - Request
Completion - Request
Intercept Request - Request
Intercept Response - Request
Transform Request - Resource
Route pluginapi.ResourceRoutewithout its host-sideHandler.- Response
Intercept Request - Response
Intercept Response - Response
Transform Request - Scheduler
Auth Candidate - Scheduler
Options - Scheduler
Pick Raw - Scheduler
Pick Request - Scheduler
Pick Response pluginapi.SchedulerPickResponse. Its customUnmarshalJSONaccepts the Go names and snake_case alternatives; a present Go name wins.- Static
Model Request - Stream
Chunk Intercept Request - Stream
Chunk Intercept Response - Thinking
Apply Request - Thinking
Config - Thinking
Support - Usage
Detail - Usage
Failure - Usage
Record - WebSocket
Response Event
Constants§
- AFFINITY_
AMBIGUOUS - AFFINITY_
BOUND - AFFINITY_
UNBOUND - AFFINITY_
UNSUPPORTED - AUTH_
LOGIN_ ERROR - AUTH_
LOGIN_ PENDING - AUTH_
LOGIN_ SUCCESS - COMPLETION_
CANCELED - COMPLETION_
FAILED - COMPLETION_
REJECTED - COMPLETION_
SUCCEEDED - ROUTE_
TARGET_ EXECUTOR - ROUTE_
TARGET_ PROVIDER - ROUTE_
TARGET_ SELF - SCHEDULER_
BUILTIN_ FILL_ FIRST - SCHEDULER_
BUILTIN_ ROUND_ ROBIN - STREAM_
CHUNK_ HEADER_ INIT_ INDEX pluginapi.StreamChunkHeaderInitIndex.
Functions§
- quota_
fetch_ from_ value - Applies the snake_case fallbacks of the quota
UnmarshalJSONmethods to a decodedquota.fetchresult.rawis the result object the plugin returned.