Skip to main content

cilroy.proto

path kilroy/cilroy/v1alpha/cilroy.proto

package kilroy.cilroy.v1alpha

Definitions for cilroy service.


Messages

GeneratePostsRequest

Request for GeneratePosts.

NameTypeDescription
quantityuint64The quantity of posts to generate.

GeneratePostsResponse

Response from GeneratePosts.

NameTypeDescription
contentstringThe content of the posts as a JSON string.

GetControllerConfigRequest

Request for GetControllerConfig.

NameTypeDescription

GetControllerConfigResponse

Response from GetControllerConfig.

NameTypeDescription
configstringThe controller config as a JSON string.

GetControllerConfigSchemaRequest

Request for GetControllerConfigSchema.

NameTypeDescription

GetControllerConfigSchemaResponse

Response from GetControllerConfigSchema.

NameTypeDescription
schemastringThe schema of the controller config as a JSON string.

GetControllerStatusRequest

Request for GetControllerStatus.

NameTypeDescription

GetControllerStatusResponse

Response from GetControllerStatus.

NameTypeDescription
statusStatusThe status of the controller.

GetFaceConfigRequest

Request for GetFaceConfig.

NameTypeDescription

GetFaceConfigResponse

Response from GetFaceConfig.

NameTypeDescription
configstringThe face config as a JSON string.

GetFaceConfigSchemaRequest

Request for GetFaceConfigSchema.

NameTypeDescription

GetFaceConfigSchemaResponse

Response from GetFaceConfigSchema.

NameTypeDescription
schemastringThe schema of the face config as a JSON string.

GetFaceMetadataRequest

Request for GetFaceMetadata.

NameTypeDescription

GetFaceMetadataResponse

Response from GetFaceMetadata.

NameTypeDescription
keystringThe key of the face.
descriptionstringThe description of the face.

GetFacePostSchemaRequest

Request for GetFacePostSchema.

NameTypeDescription

GetFacePostSchemaResponse

Response from GetFacePostSchema.

NameTypeDescription
schemastringThe schema of a post as a JSON string.

GetFaceStatusRequest

Request for GetFaceStatus.

NameTypeDescription

GetFaceStatusResponse

Response from GetFaceStatus.

NameTypeDescription
statusStatusThe status of the face.

GetFeedRequest

Request for GetFeed.

NameTypeDescription

GetFeedResponse

Response from GetFeed.

NameTypeDescription
idstringThe ID of the post.
urlstringThe URL of the post.
contentstringThe content of the post as a JSON string.
created_atstringThe creation time of the post.

GetModuleConfigRequest

Request for GetModuleConfig.

NameTypeDescription

GetModuleConfigResponse

Response from GetModuleConfig.

NameTypeDescription
configstringThe module config as a JSON string.

GetModuleConfigSchemaRequest

Request for GetModuleConfigSchema.

NameTypeDescription

GetModuleConfigSchemaResponse

Response from GetModuleConfigSchema.

NameTypeDescription
schemastringThe schema of the module config as a JSON string.

GetModuleMetadataRequest

Request for GetModuleMetadata.

NameTypeDescription

GetModuleMetadataResponse

Response from GetModuleMetadata.

NameTypeDescription
keystringThe key of the module.
descriptionstringThe description of the module.

GetModuleMetricsConfigRequest

Request for GetModuleMetricsConfig.

NameTypeDescription

GetModuleMetricsConfigResponse

Response from GetModuleMetricsConfig.

NameTypeDescription
configsMetricConfigThe metrics configs.

GetModuleMetricsRequest

Request for GetModuleMetrics.

NameTypeDescription

GetModuleMetricsResponse

Response from GetModuleMetrics.

NameTypeDescription
metricsMetricDataThe metrics data.

GetModulePostSchemaRequest

Request for GetModulePostSchema.

NameTypeDescription

GetModulePostSchemaResponse

Response from GetModulePostSchema.

NameTypeDescription
schemastringThe schema of a post as a JSON string.

GetModuleStatusRequest

Request for GetModuleStatus.

NameTypeDescription

GetModuleStatusResponse

Response from GetModuleStatus.

NameTypeDescription
statusStatusThe status of the module.

GetTrainingStatusRequest

Request for GetTrainingStatus.

NameTypeDescription

GetTrainingStatusResponse

Response from GetTrainingStatus.

NameTypeDescription
statusTrainingStatusThe training status.

MetricConfig

Metric configuration data.

NameTypeDescription
idstringThe ID of the metric.
labelstringThe label of the metric.
configstringThe config of the metric as a JSON string.
tagsstringThe tags of the metric.

MetricData

Metric data.

NameTypeDescription
metric_idstringThe ID of the metric.
dataset_iduint64The ID of the dataset.
datastringThe data of the metric as a JSON string.

ResetControllerRequest

Request for ResetController.

NameTypeDescription

ResetControllerResponse

Response from ResetController.

NameTypeDescription

ResetFaceRequest

Request for ResetFace.

NameTypeDescription

ResetFaceResponse

Response from ResetFace.

NameTypeDescription

ResetModuleRequest

Request for ResetModule.

NameTypeDescription

ResetModuleResponse

Response from ResetModule.

NameTypeDescription

SaveControllerRequest

Request for SaveController.

NameTypeDescription

SaveControllerResponse

Response from SaveController.

NameTypeDescription

SaveFaceRequest

Request for SaveFace.

NameTypeDescription

SaveFaceResponse

Response from SaveFace.

NameTypeDescription

SaveModuleRequest

Request for SaveModule.

NameTypeDescription

SaveModuleResponse

Response from SaveModule.

NameTypeDescription

SetControllerConfigRequest

Request for SetControllerConfig.

NameTypeDescription
configstringThe controller config as a JSON string.

SetControllerConfigResponse

Response from SetControllerConfig.

NameTypeDescription
configstringThe controller config as a JSON string.

SetFaceConfigRequest

Request for SetFaceConfig.

NameTypeDescription
configstringThe face config as a JSON string.

SetFaceConfigResponse

Response from SetFaceConfig.

NameTypeDescription
configstringThe face config as a JSON string.

SetModuleConfigRequest

Request for SetModuleConfig.

NameTypeDescription
configstringThe module config as a JSON string.

SetModuleConfigResponse

Response from SetModuleConfig.

NameTypeDescription
configstringThe module config as a JSON string.

StopTrainingRequest

Request for StopTraining.

NameTypeDescription

StopTrainingResponse

Response from StopTraining.

NameTypeDescription

TrainOfflineRequest

Request for TrainOffline.

NameTypeDescription

TrainOfflineResponse

Response from TrainOffline.

NameTypeDescription

TrainOnlineRequest

Request for TrainOnline.

NameTypeDescription

TrainOnlineResponse

Response from TrainOnline.

NameTypeDescription

WatchAllRequest

Request for WatchAll.

NameTypeDescription

WatchAllResponse

Response from WatchAll.

NameTypeDescription
methodstringThe method that the message is from.
messagestringThe message as a JSON string.

WatchControllerConfigRequest

Request for WatchControllerConfig.

NameTypeDescription

WatchControllerConfigResponse

Response from WatchControllerConfig.

NameTypeDescription
configstringThe controller config as a JSON string.

WatchControllerStatusRequest

Request for WatchControllerStatus.

NameTypeDescription

WatchControllerStatusResponse

Response from WatchControllerStatus.

NameTypeDescription
statusStatusThe status of the controller.

WatchFaceConfigRequest

Request for WatchFaceConfig.

NameTypeDescription

WatchFaceConfigResponse

Response from WatchFaceConfig.

NameTypeDescription
configstringThe face config as a JSON string.

WatchFaceStatusRequest

Request for WatchFaceStatus.

NameTypeDescription

WatchFaceStatusResponse

Response from WatchFaceStatus.

NameTypeDescription
statusStatusThe status of the face.

WatchFeedRequest

Request for WatchFeed.

NameTypeDescription

WatchFeedResponse

Response from WatchFeed.

NameTypeDescription
idstringThe ID of the post.
urlstringThe URL of the post.
contentstringThe content of the post as a JSON string.
created_atstringThe creation time of the post.

WatchModuleConfigRequest

Request for WatchModuleConfig.

NameTypeDescription

WatchModuleConfigResponse

Response from WatchModuleConfig.

NameTypeDescription
configstringThe module config as a JSON string.

WatchModuleMetricsRequest

Request for WatchModuleMetrics.

NameTypeDescription

WatchModuleMetricsResponse

Response from WatchModuleMetrics.

NameTypeDescription
metricMetricDataThe metric data.

WatchModuleStatusRequest

Request for WatchModuleStatus.

NameTypeDescription

WatchModuleStatusResponse

Response from WatchModuleStatus.

NameTypeDescription
statusStatusThe status of the module.

WatchTrainingStatusRequest

Request for WatchTrainingStatus.

NameTypeDescription

WatchTrainingStatusResponse

Response from WatchTrainingStatus.

NameTypeDescription
statusTrainingStatusThe training status.

Enums

Status

Possible service statuses.

NameNumberDescription
STATUS_UNSPECIFIED0Unspecified status.
STATUS_LOADING1The service is loading.
STATUS_READY2The service is ready.

TrainingStatus

Possible training statuses.

NameNumberDescription
TRAINING_STATUS_UNSPECIFIED0Unspecified training status.
TRAINING_STATUS_IDLE1The training is idle.
TRAINING_STATUS_OFFLINE2The training is in offline mode.
TRAINING_STATUS_ONLINE3The training is in online mode.

Services

CilroyService

Cilroy service.

GetFaceMetadata

MethodGetFaceMetadata
RequestGetFaceMetadataRequest
ResponseGetFaceMetadataResponse
DescriptionReturns the metadata of the face.

GetModuleMetadata

MethodGetModuleMetadata
RequestGetModuleMetadataRequest
ResponseGetModuleMetadataResponse
DescriptionReturns the metadata of the module.

GetFacePostSchema

MethodGetFacePostSchema
RequestGetFacePostSchemaRequest
ResponseGetFacePostSchemaResponse
DescriptionReturns the schema of a post as reported by the face.

GetModulePostSchema

MethodGetModulePostSchema
RequestGetModulePostSchemaRequest
ResponseGetModulePostSchemaResponse
DescriptionReturns the schema of a post as reported by the module.

GetControllerStatus

MethodGetControllerStatus
RequestGetControllerStatusRequest
ResponseGetControllerStatusResponse
DescriptionReturns the status of the controller.

WatchControllerStatus

MethodWatchControllerStatus
RequestWatchControllerStatusRequest
ResponseWatchControllerStatusResponse stream
DescriptionReturns an infinite stream of controller status updates.

GetFaceStatus

MethodGetFaceStatus
RequestGetFaceStatusRequest
ResponseGetFaceStatusResponse
DescriptionReturns the status of the face.

WatchFaceStatus

MethodWatchFaceStatus
RequestWatchFaceStatusRequest
ResponseWatchFaceStatusResponse stream
DescriptionReturns an infinite stream of face status updates.

GetModuleStatus

MethodGetModuleStatus
RequestGetModuleStatusRequest
ResponseGetModuleStatusResponse
DescriptionReturns the status of the module.

WatchModuleStatus

MethodWatchModuleStatus
RequestWatchModuleStatusRequest
ResponseWatchModuleStatusResponse stream
DescriptionReturns an infinite stream of module status updates.

GetTrainingStatus

MethodGetTrainingStatus
RequestGetTrainingStatusRequest
ResponseGetTrainingStatusResponse
DescriptionReturns the training status.

WatchTrainingStatus

MethodWatchTrainingStatus
RequestWatchTrainingStatusRequest
ResponseWatchTrainingStatusResponse stream
DescriptionReturns an infinite stream of training status updates.

GetControllerConfigSchema

MethodGetControllerConfigSchema
RequestGetControllerConfigSchemaRequest
ResponseGetControllerConfigSchemaResponse
DescriptionReturns the schema of the controller config.

GetControllerConfig

MethodGetControllerConfig
RequestGetControllerConfigRequest
ResponseGetControllerConfigResponse
DescriptionReturns the config of the controller.

WatchControllerConfig

MethodWatchControllerConfig
RequestWatchControllerConfigRequest
ResponseWatchControllerConfigResponse stream
DescriptionReturns an infinite stream of controller config updates.

SetControllerConfig

MethodSetControllerConfig
RequestSetControllerConfigRequest
ResponseSetControllerConfigResponse
DescriptionSets the config of the controller.

GetFaceConfigSchema

MethodGetFaceConfigSchema
RequestGetFaceConfigSchemaRequest
ResponseGetFaceConfigSchemaResponse
DescriptionReturns the schema of the face config.

GetFaceConfig

MethodGetFaceConfig
RequestGetFaceConfigRequest
ResponseGetFaceConfigResponse
DescriptionReturns the config of the face.

WatchFaceConfig

MethodWatchFaceConfig
RequestWatchFaceConfigRequest
ResponseWatchFaceConfigResponse stream
DescriptionReturns an infinite stream of face config updates.

SetFaceConfig

MethodSetFaceConfig
RequestSetFaceConfigRequest
ResponseSetFaceConfigResponse
DescriptionSets the config of the face.

GetModuleConfigSchema

MethodGetModuleConfigSchema
RequestGetModuleConfigSchemaRequest
ResponseGetModuleConfigSchemaResponse
DescriptionReturns the schema of the module config.

GetModuleConfig

MethodGetModuleConfig
RequestGetModuleConfigRequest
ResponseGetModuleConfigResponse
DescriptionReturns the config of the module.

WatchModuleConfig

MethodWatchModuleConfig
RequestWatchModuleConfigRequest
ResponseWatchModuleConfigResponse stream
DescriptionReturns an infinite stream of module config updates.

SetModuleConfig

MethodSetModuleConfig
RequestSetModuleConfigRequest
ResponseSetModuleConfigResponse
DescriptionSets the config of the module.

TrainOffline

MethodTrainOffline
RequestTrainOfflineRequest
ResponseTrainOfflineResponse
DescriptionStarts offline training.

TrainOnline

MethodTrainOnline
RequestTrainOnlineRequest
ResponseTrainOnlineResponse
DescriptionStarts online training.

StopTraining

MethodStopTraining
RequestStopTrainingRequest
ResponseStopTrainingResponse
DescriptionStops training.

GetModuleMetricsConfig

MethodGetModuleMetricsConfig
RequestGetModuleMetricsConfigRequest
ResponseGetModuleMetricsConfigResponse
DescriptionReturns the configuration of the module metrics.

GetModuleMetrics

MethodGetModuleMetrics
RequestGetModuleMetricsRequest
ResponseGetModuleMetricsResponse
DescriptionReturns the module metrics data.

WatchModuleMetrics

MethodWatchModuleMetrics
RequestWatchModuleMetricsRequest
ResponseWatchModuleMetricsResponse stream
DescriptionReturns an infinite stream of module metrics data updates.

WatchAll

MethodWatchAll
RequestWatchAllRequest
ResponseWatchAllResponse stream
DescriptionReturns an infinite stream of all messages.

ResetController

MethodResetController
RequestResetControllerRequest
ResponseResetControllerResponse
DescriptionResets the controller.

ResetFace

MethodResetFace
RequestResetFaceRequest
ResponseResetFaceResponse
DescriptionResets the face.

ResetModule

MethodResetModule
RequestResetModuleRequest
ResponseResetModuleResponse
DescriptionResets the module.

SaveController

MethodSaveController
RequestSaveControllerRequest
ResponseSaveControllerResponse
DescriptionSaves the controller.

SaveFace

MethodSaveFace
RequestSaveFaceRequest
ResponseSaveFaceResponse
DescriptionSaves the face.

SaveModule

MethodSaveModule
RequestSaveModuleRequest
ResponseSaveModuleResponse
DescriptionSaves the module.

GetFeed

MethodGetFeed
RequestGetFeedRequest
ResponseGetFeedResponse stream
DescriptionReturns the feed.

WatchFeed

MethodWatchFeed
RequestWatchFeedRequest
ResponseWatchFeedResponse stream
DescriptionReturns an infinite stream of feed updates.

GeneratePosts

MethodGeneratePosts
RequestGeneratePostsRequest
ResponseGeneratePostsResponse stream
DescriptionGenerates posts without any side effects.