evaluation

type CreateEvaluationResultRequest struct {
	Result *EvaluationResult `protobuf:"bytes,1,opt,name=result,proto3" json:"result,omitempty"`
	// contains filtered or unexported fields
}

type EvaluationClient interface {
	// Evaluates periodically all assessment results of a cloud service id based
	// on the given catalog id. Part of the public API, also exposed as REST.
	StartEvaluation(ctx context.Context, in *StartEvaluationRequest, opts ...grpc.CallOption) (*StartEvaluationResponse, error)
	// StopEvaluation stops the evaluation for the given target of evaluation.
	// Part of the public API, also exposed as REST.
	StopEvaluation(ctx context.Context, in *StopEvaluationRequest, opts ...grpc.CallOption) (*StopEvaluationResponse, error)
	// List all evaluation results that the user can access. It can further be
	// restricted by various filtering options. Part of the public API, also
	// exposed as REST.
	ListEvaluationResults(ctx context.Context, in *ListEvaluationResultsRequest, opts ...grpc.CallOption) (*ListEvaluationResultsResponse, error)
	// Creates an evaluation result
	CreateEvaluationResult(ctx context.Context, in *CreateEvaluationResultRequest, opts ...grpc.CallOption) (*EvaluationResult, error)
}

type EvaluationResult struct {

	// Evaluation result id
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The Cloud Service ID the evaluation belongs to
	CloudServiceId string `protobuf:"bytes,2,opt,name=cloud_service_id,json=cloudServiceId,proto3" json:"cloud_service_id,omitempty"`
	// The control id the evaluation was based on
	ControlId string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3" json:"control_id,omitempty"`
	// The category the evaluated control belongs to
	ControlCategoryName string `protobuf:"bytes,4,opt,name=control_category_name,json=controlCategoryName,proto3" json:"control_category_name,omitempty"`
	// The catalog the evaluated control belongs to
	ControlCatalogId string `protobuf:"bytes,5,opt,name=control_catalog_id,json=controlCatalogId,proto3" json:"control_catalog_id,omitempty"`
	// Optionally, specifies the parent control ID, if this is a sub-control
	ParentControlId *string `protobuf:"bytes,6,opt,name=parent_control_id,json=parentControlId,proto3,oneof" json:"parent_control_id,omitempty"`
	// Evaluation status
	Status EvaluationStatus `protobuf:"varint,7,opt,name=status,proto3,enum=clouditor.evaluation.v1.EvaluationStatus" json:"status,omitempty"`
	// Time of evaluation
	Timestamp *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=timestamp,proto3" json:"timestamp,omitempty" gorm:"serializer:timestamppb;type:datetime"`
	// List of assessment results because of which the evaluation status is not
	// 'compliant'
	FailingAssessmentResultIds []string `` /* 166-byte string literal not displayed */
	Comment                    *string  `protobuf:"bytes,10,opt,name=comment,proto3,oneof" json:"comment,omitempty"`
	// Optional, but required if the status is one of the "manually" ones. This
	// denotes how long the (manual) created evaluation result is valid. During
	// this time, no automatic results are generated for the specific control.
	ValidUntil *timestamppb.Timestamp `` /* 142-byte string literal not displayed */
	// contains filtered or unexported fields
}

type EvaluationServer interface {
	// Evaluates periodically all assessment results of a cloud service id based
	// on the given catalog id. Part of the public API, also exposed as REST.
	StartEvaluation(context.Context, *StartEvaluationRequest) (*StartEvaluationResponse, error)
	// StopEvaluation stops the evaluation for the given target of evaluation.
	// Part of the public API, also exposed as REST.
	StopEvaluation(context.Context, *StopEvaluationRequest) (*StopEvaluationResponse, error)
	// List all evaluation results that the user can access. It can further be
	// restricted by various filtering options. Part of the public API, also
	// exposed as REST.
	ListEvaluationResults(context.Context, *ListEvaluationResultsRequest) (*ListEvaluationResultsResponse, error)
	// Creates an evaluation result
	CreateEvaluationResult(context.Context, *CreateEvaluationResultRequest) (*EvaluationResult, error)
	// contains filtered or unexported methods
}

type EvaluationStatus int32

type ListEvaluationResultsRequest struct {
	Filter *ListEvaluationResultsRequest_Filter `protobuf:"bytes,1,opt,name=filter,proto3,oneof" json:"filter,omitempty"`
	// Optional. Latest results grouped by control_id.
	LatestByControlId *bool  `protobuf:"varint,2,opt,name=latest_by_control_id,json=latestByControlId,proto3,oneof" json:"latest_by_control_id,omitempty"`
	PageSize          int32  `protobuf:"varint,10,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	PageToken         string `protobuf:"bytes,11,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	OrderBy           string `protobuf:"bytes,12,opt,name=order_by,json=orderBy,proto3" json:"order_by,omitempty"`
	Asc               bool   `protobuf:"varint,13,opt,name=asc,proto3" json:"asc,omitempty"`
	// contains filtered or unexported fields
}

type ListEvaluationResultsRequest_Filter struct {

	// Optional. Lists only evaluation results for a specific cloud service.
	CloudServiceId *string `protobuf:"bytes,1,opt,name=cloud_service_id,json=cloudServiceId,proto3,oneof" json:"cloud_service_id,omitempty"`
	// Optional. Lists only evaluation results for a specific catalog.
	CatalogId *string `protobuf:"bytes,2,opt,name=catalog_id,json=catalogId,proto3,oneof" json:"catalog_id,omitempty"`
	// Optional. Lists only evaluation results for a specific control id.
	ControlId *string `protobuf:"bytes,3,opt,name=control_id,json=controlId,proto3,oneof" json:"control_id,omitempty"`
	// Optional. Lists all evaluation results for the given initial control id
	// substring, e.g., if the substring 'CMK-01.' is given it returns the
	// controls CMK-01.1B, CMK-01.1S, CMK-01.1H.
	SubControls *string `protobuf:"bytes,4,opt,name=sub_controls,json=subControls,proto3,oneof" json:"sub_controls,omitempty"`
	// Optional. Lists only results for parent controls
	ParentsOnly *bool `protobuf:"varint,5,opt,name=parents_only,json=parentsOnly,proto3,oneof" json:"parents_only,omitempty"`
	// Optional. Lists only manual results in their validity period
	ValidManualOnly *bool `protobuf:"varint,6,opt,name=valid_manual_only,json=validManualOnly,proto3,oneof" json:"valid_manual_only,omitempty"`
	// contains filtered or unexported fields
}

type ListEvaluationResultsResponse struct {
	Results       []*EvaluationResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	NextPageToken string              `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

type StartEvaluationRequest struct {
	CloudServiceId string `protobuf:"bytes,1,opt,name=cloud_service_id,json=cloudServiceId,proto3" json:"cloud_service_id,omitempty"`
	CatalogId      string `protobuf:"bytes,2,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty"`
	// The interval time in minutes the evaluation executes periodically. The
	// default interval is set to 5 minutes.
	Interval *int32 `protobuf:"varint,3,opt,name=interval,proto3,oneof" json:"interval,omitempty"`
	// contains filtered or unexported fields
}

type StartEvaluationResponse struct {
	Successful bool `protobuf:"varint,1,opt,name=successful,proto3" json:"successful,omitempty"`
	// contains filtered or unexported fields
}

type StopEvaluationRequest struct {
	CloudServiceId string `protobuf:"bytes,1,opt,name=cloud_service_id,json=cloudServiceId,proto3" json:"cloud_service_id,omitempty"`
	CatalogId      string `protobuf:"bytes,2,opt,name=catalog_id,json=catalogId,proto3" json:"catalog_id,omitempty"`
	// contains filtered or unexported fields
}

type StopEvaluationResponse struct {
	// contains filtered or unexported fields
}

type UnimplementedEvaluationServer struct {
}

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