xbus.control: Control API

Services

service Account

List(AccountListRequest)

Arguments:

• arg – AccountListRequest

Returns:

AccountListReply

Update(AccountUpdateRequest)

Arguments:

• arg – AccountUpdateRequest

Returns:

Account

Delete(AccountIDRequest)

Arguments:

• arg – AccountIDRequest

Returns:

Void

RenewAPIKey(AccountIDRequest)

Arguments:

• arg – AccountIDRequest

Returns:

Account

GetAPIKey(AccountIDRequest)

Arguments:

• arg – AccountIDRequest

Returns:

Account

SetAPIKey(AccountUpdateRequest)

Arguments:

• arg – AccountUpdateRequest

Returns:

Account

ResetCert(AccountIDRequest)

Arguments:

• arg – AccountIDRequest

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:

• arg – AccountPasswordSetRequest

Returns:

Void

service Actor

Create(ActorRequest)

Arguments:

• arg – ActorRequest

Returns:

ActorReply

Update(ActorRequest)

Arguments:

• arg – ActorRequest

Returns:

ActorReply

Delete(ActorRequest)

Arguments:

• arg – ActorRequest

Returns:

ActorReply

Query(ActorRequest)

Arguments:

• arg – ActorRequest

Returns:

ActorReply

service Envelope

Purge(Void)

Returns:

TaskProgress

GetStorageStat(Void)

Returns:

StorageStat

service Logs

Purge(LogsPurgeRequest)

Arguments:

• arg – LogsPurgeRequest

Returns:

LogsPurgeReply

GetStorageStat(Void)

Returns:

StorageStat

service PMProcess

Query(PMProcessQueryRequest)

Arguments:

• arg – PMProcessQueryRequest

Returns:

PMProcessQueryReply

SetStatus(PMProcessSetStatusRequest)

Arguments:

• arg – PMProcessSetStatusRequest

Returns:

Void

service Pipeline

Query(PipelineQueryRequest)

Arguments:

• arg – PipelineQueryRequest

Returns:

PipelineQueryReply

Save(PipelineSaveRequest)

Arguments:

• arg – PipelineSaveRequest

Returns:

PipelineSaveReply

SetStatus(PipelineInfo)

Arguments:

• arg – PipelineInfo

Returns:

PipelineSetStatusReply

GetGraph(PipelineInfo)

Arguments:

• arg – PipelineInfo

Returns:

StringReply

service Process

Query(ProcessQueryRequest)

Arguments:

• arg – ProcessQueryRequest

Returns:

ProcessQueryReply

QuerySummary(ProcessQueryRequest)

Arguments:

• arg – ProcessQueryRequest

Returns:

ProcessSummary

Control(ProcessControlRequest)

Arguments:

• arg – ProcessControlRequest

Returns:

Void

Export(ProcessExportRequest)

Arguments:

• arg – ProcessExportRequest

Returns:

ProcessExportReply

ExportStream(ProcessExportRequest)

Arguments:

• arg – ProcessExportRequest

Returns:

OctetStreamList

Purge(ProcessPurgeRequest)

Arguments:

• arg – ProcessPurgeRequest

Returns:

TaskProgress

Replay(ProcessReplayRequest)

Arguments:

• arg – ProcessReplayRequest

Returns:

Process

Message types

message xbus.control.AccountIDRequest

Fields:

• accountID (bytes)

message xbus.control.AccountListReply

Fields:

• accountList (Account)

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:

• actorList (Actor)

message xbus.control.ActorRequest

Fields:

• actorList (Actor)

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:

• pMProcessList (PMProcess)

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:

• pipelineList (PipelineInfo)

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:

• info (PipelineInfo)

• graph (string)

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:

• processList (Process)

message xbus.control.ProcessQueryRequest

Fields:

• filter (ProcessFilter)

message xbus.control.ProcessReplayRequest

Fields:

• process (Process)

• match (bool)

message xbus.control.ProcessSummary

Fields:

• entries (Entry)

message xbus.control.Entry

Fields:

• pipelineID (bytes)

• emitterID (bytes)

• status (Status)

• resultAcked (bool)

• count (uint64)

message xbus.control.StorageStat

Fields:

• entries (Entry)

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)