bireportgenerator

package
v1.7.63 Latest Latest
Warning

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

 Go to latest Published: Feb 21, 2024 License: Apache-2.0 Imports: 12 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	BIReportGeneratorService_CreateReportJob_FullMethodName = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/CreateReportJob"
	BIReportGeneratorService_ListReportJobs_FullMethodName  = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/ListReportJobs"
	BIReportGeneratorService_UpdateReportJob_FullMethodName = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/UpdateReportJob"
	BIReportGeneratorService_DeleteReportJob_FullMethodName = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/DeleteReportJob"
	BIReportGeneratorService_GetReportJob_FullMethodName    = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/GetReportJob"
)

Variables

View Source 
var BIReportGeneratorService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "api.v1alpha1.bireportgenerator.BIReportGeneratorService",
	HandlerType: (*BIReportGeneratorServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateReportJob",
			Handler:    _BIReportGeneratorService_CreateReportJob_Handler,
		},
		{
			MethodName: "ListReportJobs",
			Handler:    _BIReportGeneratorService_ListReportJobs_Handler,
		},
		{
			MethodName: "UpdateReportJob",
			Handler:    _BIReportGeneratorService_UpdateReportJob_Handler,
		},
		{
			MethodName: "DeleteReportJob",
			Handler:    _BIReportGeneratorService_DeleteReportJob_Handler,
		},
		{
			MethodName: "GetReportJob",
			Handler:    _BIReportGeneratorService_GetReportJob_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "api/v1alpha1/bireportgenerator/service.proto",
}

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

View Source 
var File_api_v1alpha1_bireportgenerator_entities_proto protoreflect.FileDescriptor
View Source 
var File_api_v1alpha1_bireportgenerator_service_proto protoreflect.FileDescriptor

Functions

func RegisterBIReportGeneratorServiceServer 

func RegisterBIReportGeneratorServiceServer(s grpc.ServiceRegistrar, srv BIReportGeneratorServiceServer)

Types

type BIReportGeneratorServiceClient 

type BIReportGeneratorServiceClient interface {
	// CreateReportJob creates a new report job.
	CreateReportJob(ctx context.Context, in *CreateReportJobRequest, opts ...grpc.CallOption) (*CreateReportJobResponse, error)
	// ListReportJobs lists report jobs.
	ListReportJobs(ctx context.Context, in *ListReportJobsRequest, opts ...grpc.CallOption) (*ListReportJobsResponse, error)
	// UpdateReportJob updates a report job.
	UpdateReportJob(ctx context.Context, in *UpdateReportJobRequest, opts ...grpc.CallOption) (*UpdateReportJobResponse, error)
	// DeleteReportJob deletes a report job.
	DeleteReportJob(ctx context.Context, in *DeleteReportJobRequest, opts ...grpc.CallOption) (*DeleteReportJobResponse, error)
	// GetReportJob gets a report job.
	GetReportJob(ctx context.Context, in *GetReportJobRequest, opts ...grpc.CallOption) (*GetReportJobResponse, error)
}

BIReportGeneratorServiceClient is the client API for BIReportGeneratorService 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.

func NewBIReportGeneratorServiceClient 

func NewBIReportGeneratorServiceClient(cc grpc.ClientConnInterface) BIReportGeneratorServiceClient

type BIReportGeneratorServiceServer 

type BIReportGeneratorServiceServer interface {
	// CreateReportJob creates a new report job.
	CreateReportJob(context.Context, *CreateReportJobRequest) (*CreateReportJobResponse, error)
	// ListReportJobs lists report jobs.
	ListReportJobs(context.Context, *ListReportJobsRequest) (*ListReportJobsResponse, error)
	// UpdateReportJob updates a report job.
	UpdateReportJob(context.Context, *UpdateReportJobRequest) (*UpdateReportJobResponse, error)
	// DeleteReportJob deletes a report job.
	DeleteReportJob(context.Context, *DeleteReportJobRequest) (*DeleteReportJobResponse, error)
	// GetReportJob gets a report job.
	GetReportJob(context.Context, *GetReportJobRequest) (*GetReportJobResponse, error)
	// contains filtered or unexported methods
}

BIReportGeneratorServiceServer is the server API for BIReportGeneratorService service. All implementations must embed UnimplementedBIReportGeneratorServiceServer for forward compatibility

type CreateReportJobRequest 

type CreateReportJobRequest struct {

	// The report job to create.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// contains filtered or unexported fields
}

CreateReportJobRequest is the request for creating a report job.

func (*CreateReportJobRequest) Descriptor deprecated 

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

Deprecated: Use CreateReportJobRequest.ProtoReflect.Descriptor instead.

func (*CreateReportJobRequest) GetReportJob 

func (x *CreateReportJobRequest) GetReportJob() *ReportJob

func (*CreateReportJobRequest) ProtoMessage 

func (*CreateReportJobRequest) ProtoMessage()

func (*CreateReportJobRequest) ProtoReflect 

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

func (*CreateReportJobRequest) Reset 

func (x *CreateReportJobRequest) Reset()

func (*CreateReportJobRequest) String 

func (x *CreateReportJobRequest) String() string

type CreateReportJobResponse 

type CreateReportJobResponse struct {

	// The created report job.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// contains filtered or unexported fields
}

CreateReportJobResponse is the response for creating a report job.

func (*CreateReportJobResponse) Descriptor deprecated 

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

Deprecated: Use CreateReportJobResponse.ProtoReflect.Descriptor instead.

func (*CreateReportJobResponse) GetReportJob 

func (x *CreateReportJobResponse) GetReportJob() *ReportJob

func (*CreateReportJobResponse) ProtoMessage 

func (*CreateReportJobResponse) ProtoMessage()

func (*CreateReportJobResponse) ProtoReflect 

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

func (*CreateReportJobResponse) Reset 

func (x *CreateReportJobResponse) Reset()

func (*CreateReportJobResponse) String 

func (x *CreateReportJobResponse) String() string

type DeleteReportJobRequest 

type DeleteReportJobRequest struct {

	// id of the report job to delete.
	ReportJobId string `protobuf:"bytes,1,opt,name=report_job_id,json=reportJobId,proto3" json:"report_job_id,omitempty"`
	// contains filtered or unexported fields
}

DeleteReportJobRequest is the request for deleting a report job.

func (*DeleteReportJobRequest) Descriptor deprecated 

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

Deprecated: Use DeleteReportJobRequest.ProtoReflect.Descriptor instead.

func (*DeleteReportJobRequest) GetReportJobId 

func (x *DeleteReportJobRequest) GetReportJobId() string

func (*DeleteReportJobRequest) ProtoMessage 

func (*DeleteReportJobRequest) ProtoMessage()

func (*DeleteReportJobRequest) ProtoReflect 

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

func (*DeleteReportJobRequest) Reset 

func (x *DeleteReportJobRequest) Reset()

func (*DeleteReportJobRequest) String 

func (x *DeleteReportJobRequest) String() string

type DeleteReportJobResponse 

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

DeleteReportJobResponse is the response for deleting a report job.

func (*DeleteReportJobResponse) Descriptor deprecated 

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

Deprecated: Use DeleteReportJobResponse.ProtoReflect.Descriptor instead.

func (*DeleteReportJobResponse) ProtoMessage 

func (*DeleteReportJobResponse) ProtoMessage()

func (*DeleteReportJobResponse) ProtoReflect 

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

func (*DeleteReportJobResponse) Reset 

func (x *DeleteReportJobResponse) Reset()

func (*DeleteReportJobResponse) String 

func (x *DeleteReportJobResponse) String() string

type GetReportJobRequest 

type GetReportJobRequest struct {

	// id of the report job to get.
	ReportJobId string `protobuf:"bytes,1,opt,name=report_job_id,json=reportJobId,proto3" json:"report_job_id,omitempty"`
	// contains filtered or unexported fields
}

GetReportJobRequest is the request for getting a report job.

func (*GetReportJobRequest) Descriptor deprecated 

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

Deprecated: Use GetReportJobRequest.ProtoReflect.Descriptor instead.

func (*GetReportJobRequest) GetReportJobId 

func (x *GetReportJobRequest) GetReportJobId() string

func (*GetReportJobRequest) ProtoMessage 

func (*GetReportJobRequest) ProtoMessage()

func (*GetReportJobRequest) ProtoReflect 

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

func (*GetReportJobRequest) Reset 

func (x *GetReportJobRequest) Reset()

func (*GetReportJobRequest) String 

func (x *GetReportJobRequest) String() string

type GetReportJobResponse 

type GetReportJobResponse struct {

	// The report job.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// contains filtered or unexported fields
}

GetReportJobResponse is the response for getting a report job.

func (*GetReportJobResponse) Descriptor deprecated 

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

Deprecated: Use GetReportJobResponse.ProtoReflect.Descriptor instead.

func (*GetReportJobResponse) GetReportJob 

func (x *GetReportJobResponse) GetReportJob() *ReportJob

func (*GetReportJobResponse) ProtoMessage 

func (*GetReportJobResponse) ProtoMessage()

func (*GetReportJobResponse) ProtoReflect 

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

func (*GetReportJobResponse) Reset 

func (x *GetReportJobResponse) Reset()

func (*GetReportJobResponse) String 

func (x *GetReportJobResponse) String() string

type ListReportJobsRequest 

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

ListReportJobsRequest is the request for listing report jobs.

func (*ListReportJobsRequest) Descriptor deprecated 

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

Deprecated: Use ListReportJobsRequest.ProtoReflect.Descriptor instead.

func (*ListReportJobsRequest) ProtoMessage 

func (*ListReportJobsRequest) ProtoMessage()

func (*ListReportJobsRequest) ProtoReflect 

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

func (*ListReportJobsRequest) Reset 

func (x *ListReportJobsRequest) Reset()

func (*ListReportJobsRequest) String 

func (x *ListReportJobsRequest) String() string

type ListReportJobsResponse 

type ListReportJobsResponse struct {

	// The report jobs.
	ReportJobs []*ReportJob `protobuf:"bytes,1,rep,name=report_jobs,json=reportJobs,proto3" json:"report_jobs,omitempty"`
	// contains filtered or unexported fields
}

ListReportJobsResponse is the response for listing report jobs.

func (*ListReportJobsResponse) Descriptor deprecated 

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

Deprecated: Use ListReportJobsResponse.ProtoReflect.Descriptor instead.

func (*ListReportJobsResponse) GetReportJobs 

func (x *ListReportJobsResponse) GetReportJobs() []*ReportJob

func (*ListReportJobsResponse) ProtoMessage 

func (*ListReportJobsResponse) ProtoMessage()

func (*ListReportJobsResponse) ProtoReflect 

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

func (*ListReportJobsResponse) Reset 

func (x *ListReportJobsResponse) Reset()

func (*ListReportJobsResponse) String 

func (x *ListReportJobsResponse) String() string

type ReportJob 

type ReportJob struct {

	// unique identifier for the report job
	ReportJobId string `protobuf:"bytes,1,opt,name=report_job_id,json=reportJobId,proto3" json:"report_job_id,omitempty"`
	// name of the report job
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// description of the report job
	Description string `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	// dashboard id to report
	DashboardId string `protobuf:"bytes,4,opt,name=dashboard_id,json=dashboardId,proto3" json:"dashboard_id,omitempty"`
	// timezone to use for the report schedule
	TimeZone string `protobuf:"bytes,5,opt,name=time_zone,json=timeZone,proto3" json:"time_zone,omitempty"`
	// time period of data to report with
	TimePeriod commons.TimePeriod `protobuf:"varint,6,opt,name=time_period,json=timePeriod,proto3,enum=api.commons.TimePeriod" json:"time_period,omitempty"`
	// delivery times for the report
	DeliveryTimes *commons.DeliveryTimes `protobuf:"bytes,7,opt,name=delivery_times,json=deliveryTimes,proto3" json:"delivery_times,omitempty"`
	// days filter to report on
	DayFilter *commons.DayFilter `protobuf:"bytes,8,opt,name=day_filter,json=dayFilter,proto3" json:"day_filter,omitempty"`
	// months filter to report on
	Months []commons.Month `protobuf:"varint,9,rep,packed,name=months,proto3,enum=api.commons.Month" json:"months,omitempty"`
	// format options for the report
	FormatOptions *commons.FormatOptions `protobuf:"bytes,10,opt,name=format_options,json=formatOptions,proto3" json:"format_options,omitempty"`
	// delivery options for the report
	DeliveryOptions *commons.DeliveryOptions `protobuf:"bytes,11,opt,name=delivery_options,json=deliveryOptions,proto3" json:"delivery_options,omitempty"`
	// whether the report job is active
	IsActive bool `protobuf:"varint,12,opt,name=is_active,json=isActive,proto3" json:"is_active,omitempty"`
	// whether to send an empty report if no data is available
	SendEmptyReport bool `protobuf:"varint,13,opt,name=send_empty_report,json=sendEmptyReport,proto3" json:"send_empty_report,omitempty"`
	// contains filtered or unexported fields
}

ReportJob that can be scheduled to report dashboard data.

func (*ReportJob) Descriptor deprecated 

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

Deprecated: Use ReportJob.ProtoReflect.Descriptor instead.

func (*ReportJob) GetDashboardId 

func (x *ReportJob) GetDashboardId() string

func (*ReportJob) GetDayFilter 

func (x *ReportJob) GetDayFilter() *commons.DayFilter

func (*ReportJob) GetDeliveryOptions 

func (x *ReportJob) GetDeliveryOptions() *commons.DeliveryOptions

func (*ReportJob) GetDeliveryTimes 

func (x *ReportJob) GetDeliveryTimes() *commons.DeliveryTimes

func (*ReportJob) GetDescription 

func (x *ReportJob) GetDescription() string

func (*ReportJob) GetFormatOptions 

func (x *ReportJob) GetFormatOptions() *commons.FormatOptions

func (*ReportJob) GetIsActive 

func (x *ReportJob) GetIsActive() bool

func (*ReportJob) GetMonths 

func (x *ReportJob) GetMonths() []commons.Month

func (*ReportJob) GetName 

func (x *ReportJob) GetName() string

func (*ReportJob) GetReportJobId 

func (x *ReportJob) GetReportJobId() string

func (*ReportJob) GetSendEmptyReport 

func (x *ReportJob) GetSendEmptyReport() bool

func (*ReportJob) GetTimePeriod 

func (x *ReportJob) GetTimePeriod() commons.TimePeriod

func (*ReportJob) GetTimeZone 

func (x *ReportJob) GetTimeZone() string

func (*ReportJob) ProtoMessage 

func (*ReportJob) ProtoMessage()

func (*ReportJob) ProtoReflect 

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

func (*ReportJob) Reset 

func (x *ReportJob) Reset()

func (*ReportJob) String 

func (x *ReportJob) String() string

type UnimplementedBIReportGeneratorServiceServer 

type UnimplementedBIReportGeneratorServiceServer struct {
}

UnimplementedBIReportGeneratorServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedBIReportGeneratorServiceServer) CreateReportJob 

func (UnimplementedBIReportGeneratorServiceServer) CreateReportJob(context.Context, *CreateReportJobRequest) (*CreateReportJobResponse, error)

func (UnimplementedBIReportGeneratorServiceServer) DeleteReportJob 

func (UnimplementedBIReportGeneratorServiceServer) DeleteReportJob(context.Context, *DeleteReportJobRequest) (*DeleteReportJobResponse, error)

func (UnimplementedBIReportGeneratorServiceServer) GetReportJob 

func (UnimplementedBIReportGeneratorServiceServer) GetReportJob(context.Context, *GetReportJobRequest) (*GetReportJobResponse, error)

func (UnimplementedBIReportGeneratorServiceServer) ListReportJobs 

func (UnimplementedBIReportGeneratorServiceServer) ListReportJobs(context.Context, *ListReportJobsRequest) (*ListReportJobsResponse, error)

func (UnimplementedBIReportGeneratorServiceServer) UpdateReportJob 

func (UnimplementedBIReportGeneratorServiceServer) UpdateReportJob(context.Context, *UpdateReportJobRequest) (*UpdateReportJobResponse, error)

type UnsafeBIReportGeneratorServiceServer 

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

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

type UpdateReportJobRequest 

type UpdateReportJobRequest struct {

	// The report job to update.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// The fields to update.
	UpdateMask *fieldmaskpb.FieldMask `protobuf:"bytes,2,opt,name=update_mask,json=updateMask,proto3" json:"update_mask,omitempty"`
	// contains filtered or unexported fields
}

UpdateReportJobRequest is the request for updating a report job.

func (*UpdateReportJobRequest) Descriptor deprecated 

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

Deprecated: Use UpdateReportJobRequest.ProtoReflect.Descriptor instead.

func (*UpdateReportJobRequest) GetReportJob 

func (x *UpdateReportJobRequest) GetReportJob() *ReportJob

func (*UpdateReportJobRequest) GetUpdateMask 

func (x *UpdateReportJobRequest) GetUpdateMask() *fieldmaskpb.FieldMask

func (*UpdateReportJobRequest) ProtoMessage 

func (*UpdateReportJobRequest) ProtoMessage()

func (*UpdateReportJobRequest) ProtoReflect 

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

func (*UpdateReportJobRequest) Reset 

func (x *UpdateReportJobRequest) Reset()

func (*UpdateReportJobRequest) String 

func (x *UpdateReportJobRequest) String() string

type UpdateReportJobResponse 

type UpdateReportJobResponse struct {

	// The updated report job.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// contains filtered or unexported fields
}

UpdateReportJobResponse is the response for updating a report job.

func (*UpdateReportJobResponse) Descriptor deprecated 

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

Deprecated: Use UpdateReportJobResponse.ProtoReflect.Descriptor instead.

func (*UpdateReportJobResponse) GetReportJob 

func (x *UpdateReportJobResponse) GetReportJob() *ReportJob

func (*UpdateReportJobResponse) ProtoMessage 

func (*UpdateReportJobResponse) ProtoMessage()

func (*UpdateReportJobResponse) ProtoReflect 

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

func (*UpdateReportJobResponse) Reset 

func (x *UpdateReportJobResponse) Reset()

func (*UpdateReportJobResponse) String 

func (x *UpdateReportJobResponse) String() string

Source Files

View all Source files

Directories

Path Synopsis

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.