report

package
v1.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 16, 2025 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Report_ExecuteDbQuery_FullMethodName    = "/veidemann.api.report.v1.Report/ExecuteDbQuery"
	Report_ListExecutions_FullMethodName    = "/veidemann.api.report.v1.Report/ListExecutions"
	Report_ListJobExecutions_FullMethodName = "/veidemann.api.report.v1.Report/ListJobExecutions"
)

Variables

View Source 
var File_report_v1_report_proto protoreflect.FileDescriptor
View Source 
var File_report_v1_resources_proto protoreflect.FileDescriptor
View Source 
var Report_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "veidemann.api.report.v1.Report",
	HandlerType: (*ReportServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ExecuteDbQuery",
			Handler:       _Report_ExecuteDbQuery_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ListExecutions",
			Handler:       _Report_ListExecutions_Handler,
			ServerStreams: true,
		},
		{
			StreamName:    "ListJobExecutions",
			Handler:       _Report_ListJobExecutions_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "report/v1/report.proto",
}

Report_ServiceDesc is the grpc.ServiceDesc for Report service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterReportServer 

func RegisterReportServer(s grpc.ServiceRegistrar, srv ReportServer)

Types

type CrawlExecutionsListRequest 

type CrawlExecutionsListRequest struct {

	// Select objects by one or more id's
	Id                 []string                              `protobuf:"bytes,1,rep,name=id,proto3" json:"id,omitempty"`
	State              []frontier.CrawlExecutionStatus_State `` /* 129-byte string literal not displayed */
	StartTimeFrom      *timestamppb.Timestamp                `protobuf:"bytes,3,opt,name=start_time_from,json=startTimeFrom,proto3" json:"start_time_from,omitempty"`
	StartTimeTo        *timestamppb.Timestamp                `protobuf:"bytes,4,opt,name=start_time_to,json=startTimeTo,proto3" json:"start_time_to,omitempty"`
	HasError           bool                                  `protobuf:"varint,5,opt,name=has_error,json=hasError,proto3" json:"has_error,omitempty"`
	QueryTemplate      *frontier.CrawlExecutionStatus        `protobuf:"bytes,6,opt,name=query_template,json=queryTemplate,proto3" json:"query_template,omitempty"`
	QueryMask          *commons.FieldMask                    `protobuf:"bytes,7,opt,name=query_mask,json=queryMask,proto3" json:"query_mask,omitempty"`
	ReturnedFieldsMask *commons.FieldMask                    `protobuf:"bytes,8,opt,name=returned_fields_mask,json=returnedFieldsMask,proto3" json:"returned_fields_mask,omitempty"`
	OrderByPath        string                                `protobuf:"bytes,9,opt,name=order_by_path,json=orderByPath,proto3" json:"order_by_path,omitempty"`
	OrderDescending    bool                                  `protobuf:"varint,10,opt,name=order_descending,json=orderDescending,proto3" json:"order_descending,omitempty"`
	Watch              bool                                  `protobuf:"varint,13,opt,name=watch,proto3" json:"watch,omitempty"`
	PageSize           int32                                 `protobuf:"varint,14,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	Offset             int32                                 `protobuf:"varint,15,opt,name=offset,proto3" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

func (*CrawlExecutionsListRequest) Descriptor deprecated 

func (*CrawlExecutionsListRequest) Descriptor() ([]byte, []int)

Deprecated: Use CrawlExecutionsListRequest.ProtoReflect.Descriptor instead.

func (*CrawlExecutionsListRequest) GetHasError 

func (x *CrawlExecutionsListRequest) GetHasError() bool

func (*CrawlExecutionsListRequest) GetId 

func (x *CrawlExecutionsListRequest) GetId() []string

func (*CrawlExecutionsListRequest) GetOffset 

func (x *CrawlExecutionsListRequest) GetOffset() int32

func (*CrawlExecutionsListRequest) GetOrderByPath 

func (x *CrawlExecutionsListRequest) GetOrderByPath() string

func (*CrawlExecutionsListRequest) GetOrderDescending 

func (x *CrawlExecutionsListRequest) GetOrderDescending() bool

func (*CrawlExecutionsListRequest) GetPageSize 

func (x *CrawlExecutionsListRequest) GetPageSize() int32

func (*CrawlExecutionsListRequest) GetQueryMask 

func (x *CrawlExecutionsListRequest) GetQueryMask() *commons.FieldMask

func (*CrawlExecutionsListRequest) GetQueryTemplate 

func (x *CrawlExecutionsListRequest) GetQueryTemplate() *frontier.CrawlExecutionStatus

func (*CrawlExecutionsListRequest) GetReturnedFieldsMask 

func (x *CrawlExecutionsListRequest) GetReturnedFieldsMask() *commons.FieldMask

func (*CrawlExecutionsListRequest) GetStartTimeFrom 

func (x *CrawlExecutionsListRequest) GetStartTimeFrom() *timestamppb.Timestamp

func (*CrawlExecutionsListRequest) GetStartTimeTo 

func (x *CrawlExecutionsListRequest) GetStartTimeTo() *timestamppb.Timestamp

func (*CrawlExecutionsListRequest) GetState 

func (x *CrawlExecutionsListRequest) GetState() []frontier.CrawlExecutionStatus_State

func (*CrawlExecutionsListRequest) GetWatch 

func (x *CrawlExecutionsListRequest) GetWatch() bool

func (*CrawlExecutionsListRequest) ProtoMessage 

func (*CrawlExecutionsListRequest) ProtoMessage()

func (*CrawlExecutionsListRequest) ProtoReflect 

func (x *CrawlExecutionsListRequest) ProtoReflect() protoreflect.Message

func (*CrawlExecutionsListRequest) Reset 

func (x *CrawlExecutionsListRequest) Reset()

func (*CrawlExecutionsListRequest) String 

func (x *CrawlExecutionsListRequest) String() string

type ExecuteDbQueryReply 

type ExecuteDbQueryReply struct {
	Record string `protobuf:"bytes,1,opt,name=record,proto3" json:"record,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteDbQueryReply) Descriptor deprecated 

func (*ExecuteDbQueryReply) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteDbQueryReply.ProtoReflect.Descriptor instead.

func (*ExecuteDbQueryReply) GetRecord 

func (x *ExecuteDbQueryReply) GetRecord() string

func (*ExecuteDbQueryReply) ProtoMessage 

func (*ExecuteDbQueryReply) ProtoMessage()

func (*ExecuteDbQueryReply) ProtoReflect 

func (x *ExecuteDbQueryReply) ProtoReflect() protoreflect.Message

func (*ExecuteDbQueryReply) Reset 

func (x *ExecuteDbQueryReply) Reset()

func (*ExecuteDbQueryReply) String 

func (x *ExecuteDbQueryReply) String() string

type ExecuteDbQueryRequest 

type ExecuteDbQueryRequest struct {

	// The query to execute
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Maximum number of rows to return. A limit of -1 indicates no limit. If unset or zero, use default limit.
	Limit int32 `protobuf:"varint,14,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*ExecuteDbQueryRequest) Descriptor deprecated 

func (*ExecuteDbQueryRequest) Descriptor() ([]byte, []int)

Deprecated: Use ExecuteDbQueryRequest.ProtoReflect.Descriptor instead.

func (*ExecuteDbQueryRequest) GetLimit 

func (x *ExecuteDbQueryRequest) GetLimit() int32

func (*ExecuteDbQueryRequest) GetQuery 

func (x *ExecuteDbQueryRequest) GetQuery() string

func (*ExecuteDbQueryRequest) ProtoMessage 

func (*ExecuteDbQueryRequest) ProtoMessage()

func (*ExecuteDbQueryRequest) ProtoReflect 

func (x *ExecuteDbQueryRequest) ProtoReflect() protoreflect.Message

func (*ExecuteDbQueryRequest) Reset 

func (x *ExecuteDbQueryRequest) Reset()

func (*ExecuteDbQueryRequest) String 

func (x *ExecuteDbQueryRequest) String() string

type JobExecutionsListRequest 

type JobExecutionsListRequest struct {

	// Select objects by one or more id's
	Id                 []string                            `protobuf:"bytes,1,rep,name=id,proto3" json:"id,omitempty"`
	State              []frontier.JobExecutionStatus_State `` /* 127-byte string literal not displayed */
	StartTimeFrom      *timestamppb.Timestamp              `protobuf:"bytes,3,opt,name=start_time_from,json=startTimeFrom,proto3" json:"start_time_from,omitempty"`
	StartTimeTo        *timestamppb.Timestamp              `protobuf:"bytes,4,opt,name=start_time_to,json=startTimeTo,proto3" json:"start_time_to,omitempty"`
	QueryTemplate      *frontier.JobExecutionStatus        `protobuf:"bytes,6,opt,name=query_template,json=queryTemplate,proto3" json:"query_template,omitempty"`
	QueryMask          *commons.FieldMask                  `protobuf:"bytes,7,opt,name=query_mask,json=queryMask,proto3" json:"query_mask,omitempty"`
	ReturnedFieldsMask *commons.FieldMask                  `protobuf:"bytes,8,opt,name=returned_fields_mask,json=returnedFieldsMask,proto3" json:"returned_fields_mask,omitempty"`
	OrderByPath        string                              `protobuf:"bytes,9,opt,name=order_by_path,json=orderByPath,proto3" json:"order_by_path,omitempty"`
	OrderDescending    bool                                `protobuf:"varint,10,opt,name=order_descending,json=orderDescending,proto3" json:"order_descending,omitempty"`
	Watch              bool                                `protobuf:"varint,13,opt,name=watch,proto3" json:"watch,omitempty"`
	PageSize           int32                               `protobuf:"varint,14,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	Offset             int32                               `protobuf:"varint,15,opt,name=offset,proto3" json:"offset,omitempty"`
	// contains filtered or unexported fields
}

func (*JobExecutionsListRequest) Descriptor deprecated 

func (*JobExecutionsListRequest) Descriptor() ([]byte, []int)

Deprecated: Use JobExecutionsListRequest.ProtoReflect.Descriptor instead.

func (*JobExecutionsListRequest) GetId 

func (x *JobExecutionsListRequest) GetId() []string

func (*JobExecutionsListRequest) GetOffset 

func (x *JobExecutionsListRequest) GetOffset() int32

func (*JobExecutionsListRequest) GetOrderByPath 

func (x *JobExecutionsListRequest) GetOrderByPath() string

func (*JobExecutionsListRequest) GetOrderDescending 

func (x *JobExecutionsListRequest) GetOrderDescending() bool

func (*JobExecutionsListRequest) GetPageSize 

func (x *JobExecutionsListRequest) GetPageSize() int32

func (*JobExecutionsListRequest) GetQueryMask 

func (x *JobExecutionsListRequest) GetQueryMask() *commons.FieldMask

func (*JobExecutionsListRequest) GetQueryTemplate 

func (x *JobExecutionsListRequest) GetQueryTemplate() *frontier.JobExecutionStatus

func (*JobExecutionsListRequest) GetReturnedFieldsMask 

func (x *JobExecutionsListRequest) GetReturnedFieldsMask() *commons.FieldMask

func (*JobExecutionsListRequest) GetStartTimeFrom 

func (x *JobExecutionsListRequest) GetStartTimeFrom() *timestamppb.Timestamp

func (*JobExecutionsListRequest) GetStartTimeTo 

func (x *JobExecutionsListRequest) GetStartTimeTo() *timestamppb.Timestamp

func (*JobExecutionsListRequest) GetState 

func (x *JobExecutionsListRequest) GetState() []frontier.JobExecutionStatus_State

func (*JobExecutionsListRequest) GetWatch 

func (x *JobExecutionsListRequest) GetWatch() bool

func (*JobExecutionsListRequest) ProtoMessage 

func (*JobExecutionsListRequest) ProtoMessage()

func (*JobExecutionsListRequest) ProtoReflect 

func (x *JobExecutionsListRequest) ProtoReflect() protoreflect.Message

func (*JobExecutionsListRequest) Reset 

func (x *JobExecutionsListRequest) Reset()

func (*JobExecutionsListRequest) String 

func (x *JobExecutionsListRequest) String() string

type ReportClient 

type ReportClient interface {
	// Execute a query against the database
	ExecuteDbQuery(ctx context.Context, in *ExecuteDbQueryRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ExecuteDbQueryReply], error)
	// List a set of crawl executions
	ListExecutions(ctx context.Context, in *CrawlExecutionsListRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[frontier.CrawlExecutionStatus], error)
	// List a set of job executions
	ListJobExecutions(ctx context.Context, in *JobExecutionsListRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[frontier.JobExecutionStatus], error)
}

ReportClient is the client API for Report service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

Service for crawler reports.

func NewReportClient 

func NewReportClient(cc grpc.ClientConnInterface) ReportClient

type ReportServer 

type ReportServer interface {
	// Execute a query against the database
	ExecuteDbQuery(*ExecuteDbQueryRequest, grpc.ServerStreamingServer[ExecuteDbQueryReply]) error
	// List a set of crawl executions
	ListExecutions(*CrawlExecutionsListRequest, grpc.ServerStreamingServer[frontier.CrawlExecutionStatus]) error
	// List a set of job executions
	ListJobExecutions(*JobExecutionsListRequest, grpc.ServerStreamingServer[frontier.JobExecutionStatus]) error
	// contains filtered or unexported methods
}

ReportServer is the server API for Report service. All implementations must embed UnimplementedReportServer for forward compatibility.

Service for crawler reports.

type Report_ExecuteDbQueryClient 

type Report_ExecuteDbQueryClient = grpc.ServerStreamingClient[ExecuteDbQueryReply]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Report_ExecuteDbQueryServer 

type Report_ExecuteDbQueryServer = grpc.ServerStreamingServer[ExecuteDbQueryReply]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Report_ListExecutionsClient 

type Report_ListExecutionsClient = grpc.ServerStreamingClient[frontier.CrawlExecutionStatus]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Report_ListExecutionsServer 

type Report_ListExecutionsServer = grpc.ServerStreamingServer[frontier.CrawlExecutionStatus]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Report_ListJobExecutionsClient 

type Report_ListJobExecutionsClient = grpc.ServerStreamingClient[frontier.JobExecutionStatus]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type Report_ListJobExecutionsServer 

type Report_ListJobExecutionsServer = grpc.ServerStreamingServer[frontier.JobExecutionStatus]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type StatusDetail 

type StatusDetail struct {
	Id                  string                              `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	State               frontier.CrawlExecutionStatus_State `protobuf:"varint,2,opt,name=state,proto3,enum=veidemann.api.frontier.v1.CrawlExecutionStatus_State" json:"state,omitempty"`
	JobId               string                              `protobuf:"bytes,3,opt,name=jobId,proto3" json:"jobId,omitempty"`
	Seed                string                              `protobuf:"bytes,4,opt,name=seed,proto3" json:"seed,omitempty"`
	StartTime           *timestamppb.Timestamp              `protobuf:"bytes,5,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	EndTime             *timestamppb.Timestamp              `protobuf:"bytes,6,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	DocumentsCrawled    int64                               `protobuf:"varint,7,opt,name=documents_crawled,json=documentsCrawled,proto3" json:"documents_crawled,omitempty"`
	BytesCrawled        int64                               `protobuf:"varint,8,opt,name=bytes_crawled,json=bytesCrawled,proto3" json:"bytes_crawled,omitempty"`
	UrisCrawled         int64                               `protobuf:"varint,9,opt,name=uris_crawled,json=urisCrawled,proto3" json:"uris_crawled,omitempty"`
	DocumentsFailed     int64                               `protobuf:"varint,10,opt,name=documents_failed,json=documentsFailed,proto3" json:"documents_failed,omitempty"`
	DocumentsOutOfScope int64                               `protobuf:"varint,11,opt,name=documents_out_of_scope,json=documentsOutOfScope,proto3" json:"documents_out_of_scope,omitempty"`
	DocumentsRetried    int64                               `protobuf:"varint,12,opt,name=documents_retried,json=documentsRetried,proto3" json:"documents_retried,omitempty"`
	DocumentsDenied     int64                               `protobuf:"varint,13,opt,name=documents_denied,json=documentsDenied,proto3" json:"documents_denied,omitempty"`
	QueueSize           int64                               `protobuf:"varint,14,opt,name=queue_size,json=queueSize,proto3" json:"queue_size,omitempty"`
	CurrentUri          string                              `protobuf:"bytes,20,opt,name=current_uri,json=currentUri,proto3" json:"current_uri,omitempty"`
	// contains filtered or unexported fields
}

func (*StatusDetail) Descriptor deprecated 

func (*StatusDetail) Descriptor() ([]byte, []int)

Deprecated: Use StatusDetail.ProtoReflect.Descriptor instead.

func (*StatusDetail) GetBytesCrawled 

func (x *StatusDetail) GetBytesCrawled() int64

func (*StatusDetail) GetCurrentUri 

func (x *StatusDetail) GetCurrentUri() string

func (*StatusDetail) GetDocumentsCrawled 

func (x *StatusDetail) GetDocumentsCrawled() int64

func (*StatusDetail) GetDocumentsDenied 

func (x *StatusDetail) GetDocumentsDenied() int64

func (*StatusDetail) GetDocumentsFailed 

func (x *StatusDetail) GetDocumentsFailed() int64

func (*StatusDetail) GetDocumentsOutOfScope 

func (x *StatusDetail) GetDocumentsOutOfScope() int64

func (*StatusDetail) GetDocumentsRetried 

func (x *StatusDetail) GetDocumentsRetried() int64

func (*StatusDetail) GetEndTime 

func (x *StatusDetail) GetEndTime() *timestamppb.Timestamp

func (*StatusDetail) GetId 

func (x *StatusDetail) GetId() string

func (*StatusDetail) GetJobId 

func (x *StatusDetail) GetJobId() string

func (*StatusDetail) GetQueueSize 

func (x *StatusDetail) GetQueueSize() int64

func (*StatusDetail) GetSeed 

func (x *StatusDetail) GetSeed() string

func (*StatusDetail) GetStartTime 

func (x *StatusDetail) GetStartTime() *timestamppb.Timestamp

func (*StatusDetail) GetState 

func (x *StatusDetail) GetState() frontier.CrawlExecutionStatus_State

func (*StatusDetail) GetUrisCrawled 

func (x *StatusDetail) GetUrisCrawled() int64

func (*StatusDetail) ProtoMessage 

func (*StatusDetail) ProtoMessage()

func (*StatusDetail) ProtoReflect 

func (x *StatusDetail) ProtoReflect() protoreflect.Message

func (*StatusDetail) Reset 

func (x *StatusDetail) Reset()

func (*StatusDetail) String 

func (x *StatusDetail) String() string

type UnimplementedReportServer 

type UnimplementedReportServer struct{}

UnimplementedReportServer must be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedReportServer) ExecuteDbQuery 

func (UnimplementedReportServer) ExecuteDbQuery(*ExecuteDbQueryRequest, grpc.ServerStreamingServer[ExecuteDbQueryReply]) error

func (UnimplementedReportServer) ListExecutions 

func (UnimplementedReportServer) ListExecutions(*CrawlExecutionsListRequest, grpc.ServerStreamingServer[frontier.CrawlExecutionStatus]) error

func (UnimplementedReportServer) ListJobExecutions 

func (UnimplementedReportServer) ListJobExecutions(*JobExecutionsListRequest, grpc.ServerStreamingServer[frontier.JobExecutionStatus]) error

type UnsafeReportServer 

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

UnsafeReportServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to ReportServer will result in compilation errors.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.