xbus.control: Control API

Services

service Account

List(AccountListRequest)
Arguments
Returns

AccountListReply

Update(AccountUpdateRequest)
Arguments
Returns

Account

Delete(AccountIDRequest)
Arguments
Returns

Void

RenewAPIKey(AccountIDRequest)
Arguments
Returns

Account

GetAPIKey(AccountIDRequest)
Arguments
Returns

Account

SetAPIKey(AccountUpdateRequest)
Arguments
Returns

Account

ResetCert(AccountIDRequest)
Arguments
Returns

Void

Puts a Account in the right state to renew its certificate. The account goes back to PENDING state after this operation, use with caution

PasswordSet(AccountPasswordSetRequest)
Arguments
Returns

Void

service Actor

Create(ActorRequest)
Arguments
Returns

ActorReply

Update(ActorRequest)
Arguments
Returns

ActorReply

Delete(ActorRequest)
Arguments
Returns

ActorReply

Query(ActorRequest)
Arguments
Returns

ActorReply

service Envelope

Purge(Void)
Returns

TaskProgress

GetStorageStat(Void)
Returns

StorageStat

service Logs

Purge(LogsPurgeRequest)
Arguments
Returns

LogsPurgeReply

GetStorageStat(Void)
Returns

StorageStat

service PMProcess

Query(PMProcessQueryRequest)
Arguments
Returns

PMProcessQueryReply

SetStatus(PMProcessSetStatusRequest)
Arguments
Returns

Void

service Pipeline

Query(PipelineQueryRequest)
Arguments
Returns

PipelineQueryReply

Save(PipelineSaveRequest)
Arguments
Returns

PipelineSaveReply

SetStatus(PipelineInfo)
Arguments
Returns

PipelineSetStatusReply

GetGraph(PipelineInfo)
Arguments
Returns

StringReply

service Process

Query(ProcessQueryRequest)
Arguments
Returns

ProcessQueryReply

QuerySummary(ProcessQueryRequest)
Arguments
Returns

ProcessSummary

Control(ProcessControlRequest)
Arguments
Returns

Void

Export(ProcessExportRequest)
Arguments
Returns

ProcessExportReply

ExportStream(ProcessExportRequest)
Arguments
Returns

OctetStreamList

Purge(ProcessPurgeRequest)
Arguments
Returns

TaskProgress

Replay(ProcessReplayRequest)
Arguments
Returns

Process

Message types

message xbus.control.AccountIDRequest
Fields
  • accountID (bytes) –

message xbus.control.AccountListReply
Fields
message xbus.control.AccountListRequest
message xbus.control.AccountPasswordSetRequest
Fields
  • accountID (bytes) –

  • password (string) –

message xbus.control.AccountUpdateRequest
Fields
  • account (Account) –

  • expire (Timestamp) –

message xbus.control.ActorReply
Fields
message xbus.control.ActorRequest
Fields
message xbus.control.LogsPurgeReply
Fields
  • count (int64) –

message xbus.control.LogsPurgeRequest
Fields
  • before (Timestamp) –

message xbus.control.OctetStreamList
Fields
  • chunks (Chunk) –

  • progression (int64) –

  • maxProgression (int64) –

message xbus.control.Chunk
Fields
  • data (bytes) –

  • index (int64) –

message xbus.control.PMProcessQueryReply
Fields
message xbus.control.PMProcessQueryRequest
Fields
  • level (LogLevel) –

  • includeClosed (bool) –

  • processIDs (bytes) –

  • returnLogs (bool) –

message xbus.control.PMProcessSetStatusRequest
Fields
  • processID (bytes) –

  • status (Status) –

  • comment (string) –

message xbus.control.PipelineQueryReply
Fields
message xbus.control.PipelineQueryRequest
Fields
  • name (string) –

message xbus.control.PipelineSaveReply
Fields
  • info (PipelineInfo) –

  • graph (string) –

  • isValid (bool) –

  • validationMessages (string) –

message xbus.control.PipelineSaveRequest
Fields
message xbus.control.PipelineSetStatusReply
Fields
  • info (PipelineInfo) –

  • isValid (bool) –

  • validationMessages (string) –

message xbus.control.ProcessControlRequest
Fields
  • processID (bytes) –

  • command (Command) –

message xbus.control.ProcessExportReply
Fields
  • processList (string) –

message xbus.control.ProcessExportRequest
Fields
  • processIDs (bytes) –

  • exportEnvelope (bool) –

  • exportJobs (bool) –

  • exportLogs (bool) –

  • exportProcessLogs (bool) –

  • envelopeSizeLimit (int64) –

  • logLevel (LogLevel) –

  • exportFull (bool) –

message xbus.control.ProcessPurgeRequest
Fields
  • processIDs (bytes) –

message xbus.control.ProcessQueryReply
Fields
message xbus.control.ProcessQueryRequest
Fields
message xbus.control.ProcessReplayRequest
Fields
  • process (Process) –

  • match (bool) –

message xbus.control.ProcessSummary
Fields
message xbus.control.Entry
Fields
  • pipelineID (bytes) –

  • emitterID (bytes) –

  • status (Status) –

  • resultAcked (bool) –

  • count (uint64) –

message xbus.control.StorageStat
Fields
message xbus.control.Entry
Fields
  • name (string) –

  • type (StorageType) –

  • implementation (string) –

  • count (uint64) –

  • estimatedSize (uint64) –

message xbus.control.TaskProgress
Fields
  • message (string) –

  • progression (uint32) –

  • maxProgression (uint32) –