bireportgenerator

package
v1.9.13 Latest Latest
Warning

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

 Go to latest Published: Jan 28, 2025 License: Apache-2.0 Imports: 14 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"
	BIReportGeneratorService_GenerateReport_FullMethodName       = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/GenerateReport"
	BIReportGeneratorService_ListReportLogsStream_FullMethodName = "/api.v1alpha1.bireportgenerator.BIReportGeneratorService/ListReportLogsStream"
)

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,
		},
		{
			MethodName: "GenerateReport",
			Handler:    _BIReportGeneratorService_GenerateReport_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListReportLogsStream",
			Handler:       _BIReportGeneratorService_ListReportLogsStream_Handler,
			ServerStreams: true,
		},
	},
	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)
	GenerateReport(ctx context.Context, in *GenerateReportRequest, opts ...grpc.CallOption) (*GenerateReportResponse, error)
	// ListReportLogsStream lists report logs with streaming
	ListReportLogsStream(ctx context.Context, in *ListReportLogsStreamRequest, opts ...grpc.CallOption) (BIReportGeneratorService_ListReportLogsStreamClient, 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.

BIReportGeneratorService is the service for generating BI reports.

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)
	GenerateReport(context.Context, *GenerateReportRequest) (*GenerateReportResponse, error)
	// ListReportLogsStream lists report logs with streaming
	ListReportLogsStream(*ListReportLogsStreamRequest, BIReportGeneratorService_ListReportLogsStreamServer) error
	// contains filtered or unexported methods
}

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

BIReportGeneratorService is the service for generating BI reports.

type BIReportGeneratorService_ListReportLogsStreamClient added in v1.9.12 

type BIReportGeneratorService_ListReportLogsStreamClient interface {
	Recv() (*ListReportLogsStreamResponse, error)
	grpc.ClientStream
}

type BIReportGeneratorService_ListReportLogsStreamServer added in v1.9.12 

type BIReportGeneratorService_ListReportLogsStreamServer interface {
	Send(*ListReportLogsStreamResponse) error
	grpc.ServerStream
}

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 GenerateReportRequest added in v1.7.65 

type GenerateReportRequest struct {

	// The report job to generate the report for.
	ReportJob *ReportJob `protobuf:"bytes,1,opt,name=report_job,json=reportJob,proto3" json:"report_job,omitempty"`
	// When to send the report as
	SendAsOfDate *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=send_as_of_date,json=sendAsOfDate,proto3" json:"send_as_of_date,omitempty"`
	// contains filtered or unexported fields
}

GenerateReportRequest is the request for generating a report.

func (*GenerateReportRequest) Descriptor deprecated added in v1.7.65 

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

Deprecated: Use GenerateReportRequest.ProtoReflect.Descriptor instead.

func (*GenerateReportRequest) GetReportJob added in v1.7.65 

func (x *GenerateReportRequest) GetReportJob() *ReportJob

func (*GenerateReportRequest) GetSendAsOfDate added in v1.7.76 

func (x *GenerateReportRequest) GetSendAsOfDate() *timestamppb.Timestamp

func (*GenerateReportRequest) ProtoMessage added in v1.7.65 

func (*GenerateReportRequest) ProtoMessage()

func (*GenerateReportRequest) ProtoReflect added in v1.7.65 

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

func (*GenerateReportRequest) Reset added in v1.7.65 

func (x *GenerateReportRequest) Reset()

func (*GenerateReportRequest) String added in v1.7.65 

func (x *GenerateReportRequest) String() string

type GenerateReportResponse added in v1.7.65 

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

GenerateReportResponse is the response for generating a report.

func (*GenerateReportResponse) Descriptor deprecated added in v1.7.65 

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

Deprecated: Use GenerateReportResponse.ProtoReflect.Descriptor instead.

func (*GenerateReportResponse) ProtoMessage added in v1.7.65 

func (*GenerateReportResponse) ProtoMessage()

func (*GenerateReportResponse) ProtoReflect added in v1.7.65 

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

func (*GenerateReportResponse) Reset added in v1.7.65 

func (x *GenerateReportResponse) Reset()

func (*GenerateReportResponse) String added in v1.7.65 

func (x *GenerateReportResponse) 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 ListReportLogsStreamRequest added in v1.9.12 

type ListReportLogsStreamRequest struct {

	// the start time window to list report logs
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// the end time window to list report logs
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// contains filtered or unexported fields
}

ListReportLogsStreamRequest is the request for listing report logs with streaming

func (*ListReportLogsStreamRequest) Descriptor deprecated added in v1.9.12 

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

Deprecated: Use ListReportLogsStreamRequest.ProtoReflect.Descriptor instead.

func (*ListReportLogsStreamRequest) GetEndTime added in v1.9.12 

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

func (*ListReportLogsStreamRequest) GetStartTime added in v1.9.12 

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

func (*ListReportLogsStreamRequest) ProtoMessage added in v1.9.12 

func (*ListReportLogsStreamRequest) ProtoMessage()

func (*ListReportLogsStreamRequest) ProtoReflect added in v1.9.12 

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

func (*ListReportLogsStreamRequest) Reset added in v1.9.12 

func (x *ListReportLogsStreamRequest) Reset()

func (*ListReportLogsStreamRequest) String added in v1.9.12 

func (x *ListReportLogsStreamRequest) String() string

type ListReportLogsStreamResponse added in v1.9.12 

type ListReportLogsStreamResponse struct {

	// report_log describes a report log
	ReportLog *ReportLog `protobuf:"bytes,1,opt,name=report_log,json=reportLog,proto3" json:"report_log,omitempty"`
	// contains filtered or unexported fields
}

ListReportLogsStreamResponse is the response for listing report logs with streaming

func (*ListReportLogsStreamResponse) Descriptor deprecated added in v1.9.12 

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

Deprecated: Use ListReportLogsStreamResponse.ProtoReflect.Descriptor instead.

func (*ListReportLogsStreamResponse) GetReportLog added in v1.9.12 

func (x *ListReportLogsStreamResponse) GetReportLog() *ReportLog

func (*ListReportLogsStreamResponse) ProtoMessage added in v1.9.12 

func (*ListReportLogsStreamResponse) ProtoMessage()

func (*ListReportLogsStreamResponse) ProtoReflect added in v1.9.12 

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

func (*ListReportLogsStreamResponse) Reset added in v1.9.12 

func (x *ListReportLogsStreamResponse) Reset()

func (*ListReportLogsStreamResponse) String added in v1.9.12 

func (x *ListReportLogsStreamResponse) 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
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	DashboardId string `protobuf:"bytes,4,opt,name=dashboard_id,json=dashboardId,proto3" json:"dashboard_id,omitempty"`
	// time zone to use for the report schedule
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	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
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	DeliveryTimes *commons.DeliveryTimes `protobuf:"bytes,7,opt,name=delivery_times,json=deliveryTimes,proto3" json:"delivery_times,omitempty"`
	// days filter to report on
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	DayFilter *commons.DayFilter `protobuf:"bytes,8,opt,name=day_filter,json=dayFilter,proto3" json:"day_filter,omitempty"`
	// months filter to report on
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	Months []commons.Month `protobuf:"varint,9,rep,packed,name=months,proto3,enum=api.commons.Month" json:"months,omitempty"`
	// format options for the report
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	FormatOptions *commons.FormatOptions `protobuf:"bytes,10,opt,name=format_options,json=formatOptions,proto3" json:"format_options,omitempty"`
	// delivery options for the report
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	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"`
	// dashboard resource id to report
	DashboardResourceId string `protobuf:"bytes,14,opt,name=dashboard_resource_id,json=dashboardResourceId,proto3" json:"dashboard_resource_id,omitempty"`
	// time_zone_wrapper to use for the report schedule
	TimeZoneWrapper *commons.TimeZoneWrapper `protobuf:"bytes,15,opt,name=time_zone_wrapper,json=timeZoneWrapper,proto3" json:"time_zone_wrapper,omitempty"`
	// hide csv footer
	HideCsvFooter bool `protobuf:"varint,16,opt,name=hide_csv_footer,json=hideCsvFooter,proto3" json:"hide_csv_footer,omitempty"`
	// transfer_config_sid to use for the report delivery
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	TransferConfigSid int64 `protobuf:"varint,17,opt,name=transfer_config_sid,json=transferConfigSid,proto3" json:"transfer_config_sid,omitempty"`
	// cron expression for the report schedule
	CronExpression *commons.CronExpression `protobuf:"bytes,18,opt,name=cron_expression,json=cronExpression,proto3" json:"cron_expression,omitempty"`
	// transfer_options are options used for the report delivery
	TransferOptions *commons.TransferOptions `protobuf:"bytes,19,opt,name=transfer_options,json=transferOptions,proto3" json:"transfer_options,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) GetCronExpression added in v1.7.66 

func (x *ReportJob) GetCronExpression() *commons.CronExpression

func (*ReportJob) GetDashboardId deprecated 

func (x *ReportJob) GetDashboardId() string

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetDashboardResourceId added in v1.7.65 

func (x *ReportJob) GetDashboardResourceId() string

func (*ReportJob) GetDayFilter deprecated 

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

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetDeliveryOptions deprecated 

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

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetDeliveryTimes deprecated 

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

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetDescription 

func (x *ReportJob) GetDescription() string

func (*ReportJob) GetFormatOptions deprecated 

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

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetHideCsvFooter added in v1.7.65 

func (x *ReportJob) GetHideCsvFooter() bool

func (*ReportJob) GetIsActive 

func (x *ReportJob) GetIsActive() bool

func (*ReportJob) GetMonths deprecated 

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

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

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 deprecated 

func (x *ReportJob) GetTimeZone() string

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetTimeZoneWrapper added in v1.7.65 

func (x *ReportJob) GetTimeZoneWrapper() *commons.TimeZoneWrapper

func (*ReportJob) GetTransferConfigSid deprecated added in v1.7.66 

func (x *ReportJob) GetTransferConfigSid() int64

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportJob) GetTransferOptions added in v1.7.75 

func (x *ReportJob) GetTransferOptions() *commons.TransferOptions

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 ReportLog added in v1.9.12 

type ReportLog struct {

	// org id of the report log
	OrgId string `protobuf:"bytes,1,opt,name=org_id,json=orgId,proto3" json:"org_id,omitempty"`
	// report log id
	ReportLogId int64 `protobuf:"varint,2,opt,name=report_log_id,json=reportLogId,proto3" json:"report_log_id,omitempty"`
	// report job id
	ReportJobId int64 `protobuf:"varint,3,opt,name=report_job_id,json=reportJobId,proto3" json:"report_job_id,omitempty"`
	// unique id of the job execution
	ExecutionId string `protobuf:"bytes,4,opt,name=execution_id,json=executionId,proto3" json:"execution_id,omitempty"`
	// name of the report
	ReportName string `protobuf:"bytes,5,opt,name=report_name,json=reportName,proto3" json:"report_name,omitempty"`
	// the time that the report job was requested
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	JobRequestedTime *timestamppb.Timestamp `protobuf:"bytes,6,opt,name=job_requested_time,json=jobRequestedTime,proto3" json:"job_requested_time,omitempty"`
	// the time that the report job was completed
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	JobCompletedTime *timestamppb.Timestamp `protobuf:"bytes,7,opt,name=job_completed_time,json=jobCompletedTime,proto3" json:"job_completed_time,omitempty"`
	// result of the report job
	Success bool `protobuf:"varint,8,opt,name=success,proto3" json:"success,omitempty"`
	// describes the error that last occurred for the job, if any
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	FailureReason string `protobuf:"bytes,9,opt,name=failure_reason,json=failureReason,proto3" json:"failure_reason,omitempty"`
	// current attempt number of the report job
	AttemptNumber int64 `protobuf:"varint,10,opt,name=attempt_number,json=attemptNumber,proto3" json:"attempt_number,omitempty"`
	// max attempts of the report job
	//
	// Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.
	MaxAttempts int64 `protobuf:"varint,11,opt,name=max_attempts,json=maxAttempts,proto3" json:"max_attempts,omitempty"`
	// create time of the report log
	CreateTime *timestamppb.Timestamp `protobuf:"bytes,12,opt,name=create_time,json=createTime,proto3" json:"create_time,omitempty"`
	// update time of the report log
	UpdateTime *timestamppb.Timestamp `protobuf:"bytes,13,opt,name=update_time,json=updateTime,proto3" json:"update_time,omitempty"`
	// dashboard title of the report
	DashboardTitle string `protobuf:"bytes,14,opt,name=dashboard_title,json=dashboardTitle,proto3" json:"dashboard_title,omitempty"`
	// scheduled time is the time that the report is scheduled to run
	ScheduledTime *timestamppb.Timestamp `protobuf:"bytes,15,opt,name=scheduled_time,json=scheduledTime,proto3" json:"scheduled_time,omitempty"`
	// execution start time is the actual time that the report started processing
	ExecutionStartTime *timestamppb.Timestamp `protobuf:"bytes,16,opt,name=execution_start_time,json=executionStartTime,proto3" json:"execution_start_time,omitempty"`
	// execution end time is the time the report finished processing
	ExecutionEndTime *timestamppb.Timestamp `protobuf:"bytes,17,opt,name=execution_end_time,json=executionEndTime,proto3" json:"execution_end_time,omitempty"`
	// report start date is the beginning date of the report period
	ReportStartDate *timestamppb.Timestamp `protobuf:"bytes,18,opt,name=report_start_date,json=reportStartDate,proto3" json:"report_start_date,omitempty"`
	// report end date is the ending date of the report period
	ReportEndDate *timestamppb.Timestamp `protobuf:"bytes,19,opt,name=report_end_date,json=reportEndDate,proto3" json:"report_end_date,omitempty"`
	// comments describe any errors or empty reports during processing
	Comments []string `protobuf:"bytes,20,rep,name=comments,proto3" json:"comments,omitempty"`
	// timezone is the IANA timezone string of the report
	Timezone string `protobuf:"bytes,21,opt,name=timezone,proto3" json:"timezone,omitempty"`
	// filenames are the successfully delivered files of the report
	Filenames []string `protobuf:"bytes,22,rep,name=filenames,proto3" json:"filenames,omitempty"`
	// insight count of the report
	InsightCount int64 `protobuf:"varint,23,opt,name=insight_count,json=insightCount,proto3" json:"insight_count,omitempty"`
	// delivery definition title is the name of the delivery definition of the report
	DeliveryDefinitionTitle string `` /* 133-byte string literal not displayed */
	// contains filtered or unexported fields
}

ReportLog describes information on a report log

func (*ReportLog) Descriptor deprecated added in v1.9.12 

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

Deprecated: Use ReportLog.ProtoReflect.Descriptor instead.

func (*ReportLog) GetAttemptNumber added in v1.9.12 

func (x *ReportLog) GetAttemptNumber() int64

func (*ReportLog) GetComments added in v1.9.13 

func (x *ReportLog) GetComments() []string

func (*ReportLog) GetCreateTime added in v1.9.12 

func (x *ReportLog) GetCreateTime() *timestamppb.Timestamp

func (*ReportLog) GetDashboardTitle added in v1.9.13 

func (x *ReportLog) GetDashboardTitle() string

func (*ReportLog) GetDeliveryDefinitionTitle added in v1.9.13 

func (x *ReportLog) GetDeliveryDefinitionTitle() string

func (*ReportLog) GetExecutionEndTime added in v1.9.13 

func (x *ReportLog) GetExecutionEndTime() *timestamppb.Timestamp

func (*ReportLog) GetExecutionId added in v1.9.12 

func (x *ReportLog) GetExecutionId() string

func (*ReportLog) GetExecutionStartTime added in v1.9.13 

func (x *ReportLog) GetExecutionStartTime() *timestamppb.Timestamp

func (*ReportLog) GetFailureReason deprecated added in v1.9.12 

func (x *ReportLog) GetFailureReason() string

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportLog) GetFilenames added in v1.9.13 

func (x *ReportLog) GetFilenames() []string

func (*ReportLog) GetInsightCount added in v1.9.13 

func (x *ReportLog) GetInsightCount() int64

func (*ReportLog) GetJobCompletedTime deprecated added in v1.9.12 

func (x *ReportLog) GetJobCompletedTime() *timestamppb.Timestamp

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportLog) GetJobRequestedTime deprecated added in v1.9.12 

func (x *ReportLog) GetJobRequestedTime() *timestamppb.Timestamp

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportLog) GetMaxAttempts deprecated added in v1.9.12 

func (x *ReportLog) GetMaxAttempts() int64

Deprecated: Marked as deprecated in api/v1alpha1/bireportgenerator/entities.proto.

func (*ReportLog) GetOrgId added in v1.9.12 

func (x *ReportLog) GetOrgId() string

func (*ReportLog) GetReportEndDate added in v1.9.13 

func (x *ReportLog) GetReportEndDate() *timestamppb.Timestamp

func (*ReportLog) GetReportJobId added in v1.9.12 

func (x *ReportLog) GetReportJobId() int64

func (*ReportLog) GetReportLogId added in v1.9.12 

func (x *ReportLog) GetReportLogId() int64

func (*ReportLog) GetReportName added in v1.9.12 

func (x *ReportLog) GetReportName() string

func (*ReportLog) GetReportStartDate added in v1.9.13 

func (x *ReportLog) GetReportStartDate() *timestamppb.Timestamp

func (*ReportLog) GetScheduledTime added in v1.9.13 

func (x *ReportLog) GetScheduledTime() *timestamppb.Timestamp

func (*ReportLog) GetSuccess added in v1.9.12 

func (x *ReportLog) GetSuccess() bool

func (*ReportLog) GetTimezone added in v1.9.13 

func (x *ReportLog) GetTimezone() string

func (*ReportLog) GetUpdateTime added in v1.9.12 

func (x *ReportLog) GetUpdateTime() *timestamppb.Timestamp

func (*ReportLog) ProtoMessage added in v1.9.12 

func (*ReportLog) ProtoMessage()

func (*ReportLog) ProtoReflect added in v1.9.12 

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

func (*ReportLog) Reset added in v1.9.12 

func (x *ReportLog) Reset()

func (*ReportLog) String added in v1.9.12 

func (x *ReportLog) String() string

type UnimplementedBIReportGeneratorServiceServer 

type UnimplementedBIReportGeneratorServiceServer struct{}

UnimplementedBIReportGeneratorServiceServer 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 (UnimplementedBIReportGeneratorServiceServer) CreateReportJob 

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

func (UnimplementedBIReportGeneratorServiceServer) DeleteReportJob 

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

func (UnimplementedBIReportGeneratorServiceServer) GenerateReport added in v1.7.65 

func (UnimplementedBIReportGeneratorServiceServer) GenerateReport(context.Context, *GenerateReportRequest) (*GenerateReportResponse, 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) ListReportLogsStream added in v1.9.12 

func (UnimplementedBIReportGeneratorServiceServer) ListReportLogsStream(*ListReportLogsStreamRequest, BIReportGeneratorService_ListReportLogsStreamServer) 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.