api

type CreateLogWriterRequest struct {

	// The CaraML project ID that will own the new Log Writer.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Details of single Log Writer to be deployed by Dataset Service.
	LogWriter *LogWriter `protobuf:"bytes,2,opt,name=log_writer,json=logWriter,proto3" json:"log_writer,omitempty"`
	// contains filtered or unexported fields
}

type CreateLogWriterResponse struct {

	// Details of single Log Writer deployed by Dataset Service.
	LogWriter *LogWriter `protobuf:"bytes,1,opt,name=log_writer,json=logWriter,proto3" json:"log_writer,omitempty"`
	// contains filtered or unexported fields
}

type CreateObservationServiceRequest struct {

	// The CaraML project ID that will own the observation service.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Details of single Observation Service to be deployed by Dataset Service.
	ObservationService *ObservationService `protobuf:"bytes,2,opt,name=observation_service,json=observationService,proto3" json:"observation_service,omitempty"`
	// contains filtered or unexported fields
}

type CreateObservationServiceResponse struct {

	// Details of single Observation Service deployed by Dataset Service.
	ObservationService *ObservationService `protobuf:"bytes,1,opt,name=observation_service,json=observationService,proto3" json:"observation_service,omitempty"`
	// contains filtered or unexported fields
}

type DatasetServiceClient interface {
	// ListLogMetadata return paginated list of log metadata under a project and filtered by query string.
	ListLogMetadata(ctx context.Context, in *ListLogMetadataRequest, opts ...grpc.CallOption) (*ListLogMetadataResponse, error)
	// GetLogMetadata returns metadata of a log.
	GetLogMetadata(ctx context.Context, in *GetLogMetadataRequest, opts ...grpc.CallOption) (*GetLogMetadataResponse, error)
	// ListLogWriters return paginated list of log writers under a project and filtered by query string.
	ListLogWriters(ctx context.Context, in *ListLogWritersRequest, opts ...grpc.CallOption) (*ListLogWritersResponse, error)
	// GetLogWriter return details of the log writer deployment.
	GetLogWriter(ctx context.Context, in *GetLogWriterRequest, opts ...grpc.CallOption) (*GetLogWriterResponse, error)
	// CreateLogWriter creates a new log writer deployment as specified by the details given in the request body.
	CreateLogWriter(ctx context.Context, in *CreateLogWriterRequest, opts ...grpc.CallOption) (*CreateLogWriterResponse, error)
	// UpdateLogWriter updates an existing log writer deployment as specified by the details given in the request body.
	UpdateLogWriter(ctx context.Context, in *UpdateLogWriterRequest, opts ...grpc.CallOption) (*UpdateLogWriterResponse, error)
	// ListObservationServices return paginated list of observation services under a project and filtered by query string.
	ListObservationServices(ctx context.Context, in *ListObservationServicesRequest, opts ...grpc.CallOption) (*ListObservationServicesResponse, error)
	// GetObservationService return details of the observation service deployment.
	GetObservationService(ctx context.Context, in *GetObservationServiceRequest, opts ...grpc.CallOption) (*GetObservationServiceResponse, error)
	// CreateObservationService creates a new observation service deployment as specified by the details given in the request body.
	CreateObservationService(ctx context.Context, in *CreateObservationServiceRequest, opts ...grpc.CallOption) (*CreateObservationServiceResponse, error)
	// UpdateObservationService updates an existing observation service deployment as specified by the details given in the request body.
	UpdateObservationService(ctx context.Context, in *UpdateObservationServiceRequest, opts ...grpc.CallOption) (*UpdateObservationServiceResponse, error)
}

type DatasetServiceServer interface {
	// ListLogMetadata return paginated list of log metadata under a project and filtered by query string.
	ListLogMetadata(context.Context, *ListLogMetadataRequest) (*ListLogMetadataResponse, error)
	// GetLogMetadata returns metadata of a log.
	GetLogMetadata(context.Context, *GetLogMetadataRequest) (*GetLogMetadataResponse, error)
	// ListLogWriters return paginated list of log writers under a project and filtered by query string.
	ListLogWriters(context.Context, *ListLogWritersRequest) (*ListLogWritersResponse, error)
	// GetLogWriter return details of the log writer deployment.
	GetLogWriter(context.Context, *GetLogWriterRequest) (*GetLogWriterResponse, error)
	// CreateLogWriter creates a new log writer deployment as specified by the details given in the request body.
	CreateLogWriter(context.Context, *CreateLogWriterRequest) (*CreateLogWriterResponse, error)
	// UpdateLogWriter updates an existing log writer deployment as specified by the details given in the request body.
	UpdateLogWriter(context.Context, *UpdateLogWriterRequest) (*UpdateLogWriterResponse, error)
	// ListObservationServices return paginated list of observation services under a project and filtered by query string.
	ListObservationServices(context.Context, *ListObservationServicesRequest) (*ListObservationServicesResponse, error)
	// GetObservationService return details of the observation service deployment.
	GetObservationService(context.Context, *GetObservationServiceRequest) (*GetObservationServiceResponse, error)
	// CreateObservationService creates a new observation service deployment as specified by the details given in the request body.
	CreateObservationService(context.Context, *CreateObservationServiceRequest) (*CreateObservationServiceResponse, error)
	// UpdateObservationService updates an existing observation service deployment as specified by the details given in the request body.
	UpdateObservationService(context.Context, *UpdateObservationServiceRequest) (*UpdateObservationServiceResponse, error)
}

type GetLogMetadataRequest struct {

	// The CaraML project ID to retrieve Log Metadata from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of the log metadata to retrieve.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetLogMetadataResponse struct {

	// Single log metadata stored in configured Dataset Service storage sink.
	LogMetadata *LogMetadata `protobuf:"bytes,1,opt,name=log_metadata,json=logMetadata,proto3" json:"log_metadata,omitempty"`
	// contains filtered or unexported fields
}

type GetLogWriterRequest struct {

	// The CaraML project ID to retrieve the Log Writer from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of the Log Writer resource to retrieve.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetLogWriterResponse struct {

	// Details of single Log Writer deployed by Dataset Service.
	LogWriter *LogWriter `protobuf:"bytes,1,opt,name=log_writer,json=logWriter,proto3" json:"log_writer,omitempty"`
	// contains filtered or unexported fields
}

type GetObservationServiceRequest struct {

	// The CaraML project ID to retrieve the Observation Service from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of the Observation Service resource to retrieve.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

type GetObservationServiceResponse struct {

	// Details of single Observation Service deployed by Dataset Service.
	ObservationService *ObservationService `protobuf:"bytes,1,opt,name=observation_service,json=observationService,proto3" json:"observation_service,omitempty"`
	// contains filtered or unexported fields
}

type KafkaConfig struct {

	// Kafka Brokers to connect to, comma-delimited, in the form of "<broker_host>:<broker_port>"
	Brokers string `protobuf:"bytes,1,opt,name=brokers,proto3" json:"brokers,omitempty"`
	// Kafka Topic to produce to/consume from
	Topic string `protobuf:"bytes,2,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

type ListLogMetadataRequest struct {

	// The CaraML project ID to retrieve list of Log Metadata from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// contains filtered or unexported fields
}

type ListLogMetadataResponse struct {

	// Log metadata stored in configured Dataset Service storage sink.
	LogMetadata []*LogMetadata `protobuf:"bytes,1,rep,name=log_metadata,json=logMetadata,proto3" json:"log_metadata,omitempty"`
	// contains filtered or unexported fields
}

type ListLogWritersRequest struct {

	// The CaraML project ID to retrieve list of Log Writers from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// List request details
	List *ListOption `protobuf:"bytes,2,opt,name=list,proto3" json:"list,omitempty"`
	// contains filtered or unexported fields
}

type ListLogWritersResponse struct {

	// Log Writers deployed by Dataset Service for a particular CaraML project.
	LogWriters []*LogWriter `protobuf:"bytes,1,rep,name=log_writers,json=logWriters,proto3" json:"log_writers,omitempty"`
	// contains filtered or unexported fields
}

type ListObservationServicesRequest struct {

	// The CaraML project ID to retrieve list of Observation Services from.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// List request details
	List *ListOption `protobuf:"bytes,2,opt,name=list,proto3" json:"list,omitempty"`
	// contains filtered or unexported fields
}

type ListObservationServicesResponse struct {

	// Observation Services deployed by Dataset Service for a particular CaraML project.
	ObservationServices []*ObservationService `protobuf:"bytes,1,rep,name=observation_services,json=observationServices,proto3" json:"observation_services,omitempty"`
	// contains filtered or unexported fields
}

type ListOption struct {

	// Starting offset of the list request
	Offset int32 `protobuf:"varint,1,opt,name=offset,proto3" json:"offset,omitempty"`
	// Number of entry to be returned by list request
	Limit int32 `protobuf:"varint,2,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

type LogMetadata struct {

	// Unique identifier of a log generated by a LogProducer.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the log, generated by Dataset Service.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Source of the log.
	Type LogMetadataType `protobuf:"varint,3,opt,name=type,proto3,enum=caraml.timber.v1.LogMetadataType" json:"type,omitempty"`
	// List of target names associated with a log.
	TargetNames []string `protobuf:"bytes,4,rep,name=target_names,json=targetNames,proto3" json:"target_names,omitempty"`
	// BQ table ID where the data is stored.
	BqTable string `protobuf:"bytes,5,opt,name=bq_table,json=bqTable,proto3" json:"bq_table,omitempty"`
	// Details of LogProducer that generated a log.
	LogProducer *LogProducer `protobuf:"bytes,6,opt,name=log_producer,json=logProducer,proto3" json:"log_producer,omitempty"`
	// contains filtered or unexported fields
}

type LogMetadataType int32

type LogProducer struct {

	// Unique identifier of the producer.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the producer, dependent on the type of the log.
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Name of the CaraML project that hosts the producer.
	Project string `protobuf:"bytes,3,opt,name=project,proto3" json:"project,omitempty"`
	// contains filtered or unexported fields
}

type LogWriter struct {

	// Project id that owns the log writer
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Log writer's ID
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Name of the log writer
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Log writer source
	Source *LogWriterSource `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
	// TODO: Add details of where the log is stored at
	// Status of the log writer deployment
	Status Status `protobuf:"varint,10,opt,name=status,proto3,enum=caraml.timber.v1.Status" json:"status,omitempty"`
	// Error message, will be populated if the status failed
	Error string `protobuf:"bytes,11,opt,name=error,proto3" json:"error,omitempty"`
	// Creation timestamp
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Last update timestamp
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

type LogWriterSource struct {

	// Log type. It determines whether prediction_log_source or router_log_source is populated.
	// If the value is LOG_TYPE_PREDICTION_LOG, then prediction_log_source should be valid.
	// Whereas, if the value is LOG_TYPE_ROUTER_LOG, then router_log_source should be valid.
	Type LogWriterSourceType `protobuf:"varint,1,opt,name=type,proto3,enum=caraml.timber.v1.LogWriterSourceType" json:"type,omitempty"`
	// Prediction log source details
	PredictionLogSource *PredictionLogSource `protobuf:"bytes,2,opt,name=prediction_log_source,json=predictionLogSource,proto3" json:"prediction_log_source,omitempty"`
	// Router log source details
	RouterLogSource *RouterLogSource `protobuf:"bytes,3,opt,name=router_log_source,json=routerLogSource,proto3" json:"router_log_source,omitempty"`
	// contains filtered or unexported fields
}

type LogWriterSourceType int32

type ObservationService struct {

	// Project id that owns the observation service
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// Observation service id
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Observation service name
	Name string `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	// Configuration for pull-based Observation Service data source.
	Source *ObservationServiceSource `protobuf:"bytes,4,opt,name=source,proto3" json:"source,omitempty"`
	// TODO: Add details of where the log is stored at
	// Status of the observation service
	Status Status `protobuf:"varint,10,opt,name=status,proto3,enum=caraml.timber.v1.Status" json:"status,omitempty"`
	// Error message
	Error string `protobuf:"bytes,11,opt,name=error,proto3" json:"error,omitempty"`
	// Creation timestamp
	CreatedAt *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	// Last update timestamp
	UpdatedAt *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	// contains filtered or unexported fields
}

type ObservationServiceSource struct {

	// Data source of the observation service
	Type ObservationServiceSourceType `protobuf:"varint,1,opt,name=type,proto3,enum=caraml.timber.v1.ObservationServiceSourceType" json:"type,omitempty"`
	// Kafka configuration, required if the source type is SOURCE_TYPE_KAFKA
	Kafka *KafkaConfig `protobuf:"bytes,2,opt,name=kafka,proto3" json:"kafka,omitempty"`
	// contains filtered or unexported fields
}

type ObservationServiceSourceType int32

type PredictionLogSource struct {

	// id of the model producing the prediction log
	ModelId int64 `protobuf:"varint,1,opt,name=model_id,json=modelId,proto3" json:"model_id,omitempty"`
	// name of the model producing the prediction log
	ModelName string `protobuf:"bytes,2,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
	// kafka source configuration where the prediction logs are located
	Kafka *KafkaConfig `protobuf:"bytes,3,opt,name=kafka,proto3" json:"kafka,omitempty"`
	// contains filtered or unexported fields
}

type RouterLogSource struct {

	// id of the router producing the router logs
	RouterId int64 `protobuf:"varint,1,opt,name=router_id,json=routerId,proto3" json:"router_id,omitempty"`
	// name of the router producing the router logs
	RouterName string `protobuf:"bytes,2,opt,name=router_name,json=routerName,proto3" json:"router_name,omitempty"`
	// kafka source configuration where the router logs are located
	Kafka *KafkaConfig `protobuf:"bytes,3,opt,name=kafka,proto3" json:"kafka,omitempty"`
	// contains filtered or unexported fields
}

type Status int32

type UnimplementedDatasetServiceServer struct {
}

type UnsafeDatasetServiceServer interface {
	// contains filtered or unexported methods
}

type UpdateLogWriterRequest struct {

	// The CaraML project ID that owns the Log Writer to be updated.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of Log Writer to update.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Details of single Log Writer to be updated by Dataset Service.
	LogWriter *LogWriter `protobuf:"bytes,3,opt,name=log_writer,json=logWriter,proto3" json:"log_writer,omitempty"`
	// contains filtered or unexported fields
}

type UpdateLogWriterResponse struct {

	// Details of single Log Writer updated by Dataset Service.
	LogWriter *LogWriter `protobuf:"bytes,1,opt,name=log_writer,json=logWriter,proto3" json:"log_writer,omitempty"`
	// contains filtered or unexported fields
}

type UpdateObservationServiceRequest struct {

	// The CaraML project ID that owns the Observation Service to be updated.
	ProjectId int64 `protobuf:"varint,1,opt,name=project_id,json=projectId,proto3" json:"project_id,omitempty"`
	// The ID of Observation Service to update.
	Id int64 `protobuf:"varint,2,opt,name=id,proto3" json:"id,omitempty"`
	// Details of single Observation Service to be updated by Dataset Service.
	ObservationService *ObservationService `protobuf:"bytes,3,opt,name=observation_service,json=observationService,proto3" json:"observation_service,omitempty"`
	// contains filtered or unexported fields
}

type UpdateObservationServiceResponse struct {

	// Details of single Observation Service updated by Dataset Service.
	ObservationService *ObservationService `protobuf:"bytes,1,opt,name=observation_service,json=observationService,proto3" json:"observation_service,omitempty"`
	// contains filtered or unexported fields
}