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

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

service Logs

Purge(LogsPurgeRequest)

Arguments:

• arg – LogsPurgeRequest

Returns:

LogsPurgeReply

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

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

Message types

message xbus.control.AccountIDRequest

Field accountID:   Type accountID:bytes

message xbus.control.AccountListReply

Field accountList:   Type accountList:  Account

message xbus.control.AccountListRequest

message xbus.control.AccountUpdateRequest

Field account: Type account:Account Field expire: Type expire:Timestamp

message xbus.control.ActorReply

Field actorList:   Type actorList:Actor

message xbus.control.ActorRequest

Field actorList:   Type actorList:Actor

message xbus.control.LogsPurgeReply

Field count: Type count:int64

message xbus.control.LogsPurgeRequest

Field before: Type before:Timestamp

message xbus.control.OctetStreamList

Field chunks: Type chunks:Chunk Field progression:   Type progression:  int64 Field maxProgression:   Type maxProgression:  int64

message xbus.control.Chunk

Field data: Type data:bytes Field index: Type index:int64

message xbus.control.PMProcessQueryReply

Field pMProcessList:   Type pMProcessList:  PMProcess

message xbus.control.PMProcessQueryRequest

Field level: Type level:LogLevel Field includeClosed:   Type includeClosed:  bool Field processIDs:   Type processIDs:  bytes Field returnLogs:   Type returnLogs:  bool

message xbus.control.PMProcessSetStatusRequest

Field processID:   Type processID:bytes Field status: Type status:Status Field comment: Type comment:string

message xbus.control.PipelineQueryReply

Field pipelineList:   Type pipelineList:  PipelineInfo

message xbus.control.PipelineQueryRequest

Field name: Type name:string

message xbus.control.PipelineSaveReply

Field info: Type info:PipelineInfo Field graph: Type graph:string Field isValid: Type isValid:bool Field validationMessages:   Type validationMessages:  string

message xbus.control.PipelineSaveRequest

Field info: Type info:PipelineInfo Field graph: Type graph:string

message xbus.control.PipelineSetStatusReply

Field info: Type info:PipelineInfo Field isValid: Type isValid:bool Field validationMessages:   Type validationMessages:  string

message xbus.control.ProcessControlRequest

Field processID:   Type processID:bytes Field command: Type command:Command

message xbus.control.ProcessExportReply

Field processList:   Type processList:  string

message xbus.control.ProcessExportRequest

Field processIDs:   Type processIDs:  bytes Field exportEnvelope:   Type exportEnvelope:  bool Field exportJobs:   Type exportJobs:  bool Field exportLogs:   Type exportLogs:  bool Field exportProcessLogs:   Type exportProcessLogs:  bool Field envelopeSizeLimit:   Type envelopeSizeLimit:  int64 Field logLevel: Type logLevel:LogLevel Field exportFull:   Type exportFull:  bool

message xbus.control.ProcessPurgeRequest

Field processIDs:   Type processIDs:  bytes

message xbus.control.ProcessQueryReply

Field processList:   Type processList:  Process

message xbus.control.ProcessQueryRequest

Field filter: Type filter:ProcessFilter

message xbus.control.TaskProgress

Field message: Type message:string Field progression:   Type progression:  uint32 Field maxProgression:   Type maxProgression:  uint32