pluginv2

package
v0.90.0 Latest Latest
Warning

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

 Go to latest Published: Mar 31, 2021 License: Apache-2.0 Imports: 8 Imported by: 10

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	CheckHealthResponse_HealthStatus_name = map[int32]string{
		0: "UNKNOWN",
		1: "OK",
		2: "ERROR",
	}
	CheckHealthResponse_HealthStatus_value = map[string]int32{
		"UNKNOWN": 0,
		"OK":      1,
		"ERROR":   2,
	}
)

Enum value maps for CheckHealthResponse_HealthStatus.

View Source 
var (
	StreamPacket_StreamPacketType_name = map[int32]string{
		0: "DATA_FRAME",
	}
	StreamPacket_StreamPacketType_value = map[string]int32{
		"DATA_FRAME": 0,
	}
)

Enum value maps for StreamPacket_StreamPacketType.

View Source 
var Data_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginv2.Data",
	HandlerType: (*DataServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "QueryData",
			Handler:    _Data_QueryData_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "backend.proto",
}

Data_ServiceDesc is the grpc.ServiceDesc for Data 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 Diagnostics_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginv2.Diagnostics",
	HandlerType: (*DiagnosticsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CheckHealth",
			Handler:    _Diagnostics_CheckHealth_Handler,
		},
		{
			MethodName: "CollectMetrics",
			Handler:    _Diagnostics_CollectMetrics_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "backend.proto",
}

Diagnostics_ServiceDesc is the grpc.ServiceDesc for Diagnostics 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_backend_proto protoreflect.FileDescriptor
View Source 
var Resource_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginv2.Resource",
	HandlerType: (*ResourceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "CallResource",
			Handler:       _Resource_CallResource_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "backend.proto",
}

Resource_ServiceDesc is the grpc.ServiceDesc for Resource 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 Stream_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "pluginv2.Stream",
	HandlerType: (*StreamServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CanSubscribeToStream",
			Handler:    _Stream_CanSubscribeToStream_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "RunStream",
			Handler:       _Stream_RunStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "backend.proto",
}

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

Functions

func RegisterDataServer 

func RegisterDataServer(s grpc.ServiceRegistrar, srv DataServer)

func RegisterDiagnosticsServer 

func RegisterDiagnosticsServer(s grpc.ServiceRegistrar, srv DiagnosticsServer)

func RegisterResourceServer 

func RegisterResourceServer(s grpc.ServiceRegistrar, srv ResourceServer)

func RegisterStreamServer added in v0.89.0 

func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)

Types

type AppInstanceSettings added in v0.54.0 

type AppInstanceSettings struct {
	JsonData                []byte            `protobuf:"bytes,3,opt,name=jsonData,proto3" json:"jsonData,omitempty"`
	DecryptedSecureJsonData map[string]string `` /* 187-byte string literal not displayed */
	LastUpdatedMS           int64             `protobuf:"varint,5,opt,name=lastUpdatedMS,proto3" json:"lastUpdatedMS,omitempty"`
	// contains filtered or unexported fields
}

func (*AppInstanceSettings) Descriptor deprecated added in v0.54.0 

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

Deprecated: Use AppInstanceSettings.ProtoReflect.Descriptor instead.

func (*AppInstanceSettings) GetDecryptedSecureJsonData added in v0.54.0 

func (x *AppInstanceSettings) GetDecryptedSecureJsonData() map[string]string

func (*AppInstanceSettings) GetJsonData added in v0.54.0 

func (x *AppInstanceSettings) GetJsonData() []byte

func (*AppInstanceSettings) GetLastUpdatedMS added in v0.54.0 

func (x *AppInstanceSettings) GetLastUpdatedMS() int64

func (*AppInstanceSettings) ProtoMessage added in v0.54.0 

func (*AppInstanceSettings) ProtoMessage()

func (*AppInstanceSettings) ProtoReflect added in v0.87.0 

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

func (*AppInstanceSettings) Reset added in v0.54.0 

func (x *AppInstanceSettings) Reset()

func (*AppInstanceSettings) String added in v0.54.0 

func (x *AppInstanceSettings) String() string

type CallResourceRequest 

type CallResourceRequest struct {
	PluginContext *PluginContext         `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	Path          string                 `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	Method        string                 `protobuf:"bytes,3,opt,name=method,proto3" json:"method,omitempty"`
	Url           string                 `protobuf:"bytes,4,opt,name=url,proto3" json:"url,omitempty"`
	Headers       map[string]*StringList `` /* 155-byte string literal not displayed */
	Body          []byte                 `protobuf:"bytes,6,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*CallResourceRequest) Descriptor deprecated 

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

Deprecated: Use CallResourceRequest.ProtoReflect.Descriptor instead.

func (*CallResourceRequest) GetBody 

func (x *CallResourceRequest) GetBody() []byte

func (*CallResourceRequest) GetHeaders 

func (x *CallResourceRequest) GetHeaders() map[string]*StringList

func (*CallResourceRequest) GetMethod 

func (x *CallResourceRequest) GetMethod() string

func (*CallResourceRequest) GetPath 

func (x *CallResourceRequest) GetPath() string

func (*CallResourceRequest) GetPluginContext added in v0.54.0 

func (x *CallResourceRequest) GetPluginContext() *PluginContext

func (*CallResourceRequest) GetUrl 

func (x *CallResourceRequest) GetUrl() string

func (*CallResourceRequest) ProtoMessage 

func (*CallResourceRequest) ProtoMessage()

func (*CallResourceRequest) ProtoReflect added in v0.87.0 

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

func (*CallResourceRequest) Reset 

func (x *CallResourceRequest) Reset()

func (*CallResourceRequest) String 

func (x *CallResourceRequest) String() string

type CallResourceResponse 

type CallResourceResponse struct {
	Code    int32                  `protobuf:"varint,1,opt,name=code,proto3" json:"code,omitempty"`
	Headers map[string]*StringList `` /* 155-byte string literal not displayed */
	Body    []byte                 `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

func (*CallResourceResponse) Descriptor deprecated 

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

Deprecated: Use CallResourceResponse.ProtoReflect.Descriptor instead.

func (*CallResourceResponse) GetBody 

func (x *CallResourceResponse) GetBody() []byte

func (*CallResourceResponse) GetCode 

func (x *CallResourceResponse) GetCode() int32

func (*CallResourceResponse) GetHeaders 

func (x *CallResourceResponse) GetHeaders() map[string]*StringList

func (*CallResourceResponse) ProtoMessage 

func (*CallResourceResponse) ProtoMessage()

func (*CallResourceResponse) ProtoReflect added in v0.87.0 

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

func (*CallResourceResponse) Reset 

func (x *CallResourceResponse) Reset()

func (*CallResourceResponse) String 

func (x *CallResourceResponse) String() string

type CheckHealthRequest 

type CheckHealthRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckHealthRequest) Descriptor deprecated 

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

Deprecated: Use CheckHealthRequest.ProtoReflect.Descriptor instead.

func (*CheckHealthRequest) GetPluginContext added in v0.54.0 

func (x *CheckHealthRequest) GetPluginContext() *PluginContext

func (*CheckHealthRequest) ProtoMessage 

func (*CheckHealthRequest) ProtoMessage()

func (*CheckHealthRequest) ProtoReflect added in v0.87.0 

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

func (*CheckHealthRequest) Reset 

func (x *CheckHealthRequest) Reset()

func (*CheckHealthRequest) String 

func (x *CheckHealthRequest) String() string

type CheckHealthResponse 

type CheckHealthResponse struct {
	Status      CheckHealthResponse_HealthStatus `protobuf:"varint,1,opt,name=status,proto3,enum=pluginv2.CheckHealthResponse_HealthStatus" json:"status,omitempty"`
	Message     string                           `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	JsonDetails []byte                           `protobuf:"bytes,3,opt,name=jsonDetails,proto3" json:"jsonDetails,omitempty"`
	// contains filtered or unexported fields
}

func (*CheckHealthResponse) Descriptor deprecated 

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

Deprecated: Use CheckHealthResponse.ProtoReflect.Descriptor instead.

func (*CheckHealthResponse) GetJsonDetails 

func (x *CheckHealthResponse) GetJsonDetails() []byte

func (*CheckHealthResponse) GetMessage 

func (x *CheckHealthResponse) GetMessage() string

func (*CheckHealthResponse) GetStatus 

func (x *CheckHealthResponse) GetStatus() CheckHealthResponse_HealthStatus

func (*CheckHealthResponse) ProtoMessage 

func (*CheckHealthResponse) ProtoMessage()

func (*CheckHealthResponse) ProtoReflect added in v0.87.0 

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

func (*CheckHealthResponse) Reset 

func (x *CheckHealthResponse) Reset()

func (*CheckHealthResponse) String 

func (x *CheckHealthResponse) String() string

type CheckHealthResponse_HealthStatus 

type CheckHealthResponse_HealthStatus int32
const (
	CheckHealthResponse_UNKNOWN CheckHealthResponse_HealthStatus = 0
	CheckHealthResponse_OK      CheckHealthResponse_HealthStatus = 1
	CheckHealthResponse_ERROR   CheckHealthResponse_HealthStatus = 2
)

func (CheckHealthResponse_HealthStatus) Descriptor added in v0.87.0 

func (CheckHealthResponse_HealthStatus) Descriptor() protoreflect.EnumDescriptor

func (CheckHealthResponse_HealthStatus) Enum added in v0.87.0 

func (x CheckHealthResponse_HealthStatus) Enum() *CheckHealthResponse_HealthStatus

func (CheckHealthResponse_HealthStatus) EnumDescriptor deprecated 

func (CheckHealthResponse_HealthStatus) EnumDescriptor() ([]byte, []int)

Deprecated: Use CheckHealthResponse_HealthStatus.Descriptor instead.

func (CheckHealthResponse_HealthStatus) Number added in v0.87.0 

func (x CheckHealthResponse_HealthStatus) Number() protoreflect.EnumNumber

func (CheckHealthResponse_HealthStatus) String 

func (x CheckHealthResponse_HealthStatus) String() string

func (CheckHealthResponse_HealthStatus) Type added in v0.87.0 

func (CheckHealthResponse_HealthStatus) Type() protoreflect.EnumType

type CollectMetricsRequest 

type CollectMetricsRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetricsRequest) Descriptor deprecated 

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

Deprecated: Use CollectMetricsRequest.ProtoReflect.Descriptor instead.

func (*CollectMetricsRequest) GetPluginContext added in v0.54.0 

func (x *CollectMetricsRequest) GetPluginContext() *PluginContext

func (*CollectMetricsRequest) ProtoMessage 

func (*CollectMetricsRequest) ProtoMessage()

func (*CollectMetricsRequest) ProtoReflect added in v0.87.0 

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

func (*CollectMetricsRequest) Reset 

func (x *CollectMetricsRequest) Reset()

func (*CollectMetricsRequest) String 

func (x *CollectMetricsRequest) String() string

type CollectMetricsResponse 

type CollectMetricsResponse struct {
	Metrics *CollectMetricsResponse_Payload `protobuf:"bytes,1,opt,name=metrics,proto3" json:"metrics,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetricsResponse) Descriptor deprecated 

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

Deprecated: Use CollectMetricsResponse.ProtoReflect.Descriptor instead.

func (*CollectMetricsResponse) GetMetrics 

func (x *CollectMetricsResponse) GetMetrics() *CollectMetricsResponse_Payload

func (*CollectMetricsResponse) ProtoMessage 

func (*CollectMetricsResponse) ProtoMessage()

func (*CollectMetricsResponse) ProtoReflect added in v0.87.0 

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

func (*CollectMetricsResponse) Reset 

func (x *CollectMetricsResponse) Reset()

func (*CollectMetricsResponse) String 

func (x *CollectMetricsResponse) String() string

type CollectMetricsResponse_Payload 

type CollectMetricsResponse_Payload struct {
	Prometheus []byte `protobuf:"bytes,1,opt,name=prometheus,proto3" json:"prometheus,omitempty"`
	// contains filtered or unexported fields
}

func (*CollectMetricsResponse_Payload) Descriptor deprecated 

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

Deprecated: Use CollectMetricsResponse_Payload.ProtoReflect.Descriptor instead.

func (*CollectMetricsResponse_Payload) GetPrometheus 

func (x *CollectMetricsResponse_Payload) GetPrometheus() []byte

func (*CollectMetricsResponse_Payload) ProtoMessage 

func (*CollectMetricsResponse_Payload) ProtoMessage()

func (*CollectMetricsResponse_Payload) ProtoReflect added in v0.87.0 

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

func (*CollectMetricsResponse_Payload) Reset 

func (x *CollectMetricsResponse_Payload) Reset()

func (*CollectMetricsResponse_Payload) String 

func (x *CollectMetricsResponse_Payload) String() string

type DataClient 

type DataClient interface {
	QueryData(ctx context.Context, in *QueryDataRequest, opts ...grpc.CallOption) (*QueryDataResponse, error)
}

DataClient is the client API for Data 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 NewDataClient 

func NewDataClient(cc grpc.ClientConnInterface) DataClient

type DataQuery 

type DataQuery struct {
	RefId         string     `protobuf:"bytes,1,opt,name=refId,proto3" json:"refId,omitempty"`
	MaxDataPoints int64      `protobuf:"varint,2,opt,name=maxDataPoints,proto3" json:"maxDataPoints,omitempty"`
	IntervalMS    int64      `protobuf:"varint,3,opt,name=intervalMS,proto3" json:"intervalMS,omitempty"`
	TimeRange     *TimeRange `protobuf:"bytes,4,opt,name=timeRange,proto3" json:"timeRange,omitempty"`
	Json          []byte     `protobuf:"bytes,5,opt,name=json,proto3" json:"json,omitempty"`
	QueryType     string     `protobuf:"bytes,6,opt,name=queryType,proto3" json:"queryType,omitempty"`
	// contains filtered or unexported fields
}

func (*DataQuery) Descriptor deprecated 

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

Deprecated: Use DataQuery.ProtoReflect.Descriptor instead.

func (*DataQuery) GetIntervalMS 

func (x *DataQuery) GetIntervalMS() int64

func (*DataQuery) GetJson 

func (x *DataQuery) GetJson() []byte

func (*DataQuery) GetMaxDataPoints 

func (x *DataQuery) GetMaxDataPoints() int64

func (*DataQuery) GetQueryType added in v0.60.0 

func (x *DataQuery) GetQueryType() string

func (*DataQuery) GetRefId 

func (x *DataQuery) GetRefId() string

func (*DataQuery) GetTimeRange 

func (x *DataQuery) GetTimeRange() *TimeRange

func (*DataQuery) ProtoMessage 

func (*DataQuery) ProtoMessage()

func (*DataQuery) ProtoReflect added in v0.87.0 

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

func (*DataQuery) Reset 

func (x *DataQuery) Reset()

func (*DataQuery) String 

func (x *DataQuery) String() string

type DataResponse added in v0.35.0 

type DataResponse struct {

	// Arrow encoded DataFrames
	// Frame has its own meta, warnings, and repeats refId
	Frames   [][]byte `protobuf:"bytes,1,rep,name=frames,proto3" json:"frames,omitempty"`
	Error    string   `protobuf:"bytes,2,opt,name=error,proto3" json:"error,omitempty"`
	JsonMeta []byte   `protobuf:"bytes,3,opt,name=jsonMeta,proto3" json:"jsonMeta,omitempty"` // Warning: Current ignored by frontend. Would be for metadata about the query.
	// contains filtered or unexported fields
}

func (*DataResponse) Descriptor deprecated added in v0.35.0 

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

Deprecated: Use DataResponse.ProtoReflect.Descriptor instead.

func (*DataResponse) GetError added in v0.35.0 

func (x *DataResponse) GetError() string

func (*DataResponse) GetFrames added in v0.35.0 

func (x *DataResponse) GetFrames() [][]byte

func (*DataResponse) GetJsonMeta added in v0.35.0 

func (x *DataResponse) GetJsonMeta() []byte

func (*DataResponse) ProtoMessage added in v0.35.0 

func (*DataResponse) ProtoMessage()

func (*DataResponse) ProtoReflect added in v0.87.0 

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

func (*DataResponse) Reset added in v0.35.0 

func (x *DataResponse) Reset()

func (*DataResponse) String added in v0.35.0 

func (x *DataResponse) String() string

type DataServer 

type DataServer interface {
	QueryData(context.Context, *QueryDataRequest) (*QueryDataResponse, error)
}

DataServer is the server API for Data service. All implementations should embed UnimplementedDataServer for forward compatibility

type DataSourceInstanceSettings added in v0.54.0 

type DataSourceInstanceSettings struct {
	Id                      int64             `protobuf:"varint,1,opt,name=id,proto3" json:"id,omitempty"`
	Name                    string            `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Url                     string            `protobuf:"bytes,3,opt,name=url,proto3" json:"url,omitempty"`
	User                    string            `protobuf:"bytes,4,opt,name=user,proto3" json:"user,omitempty"`
	Database                string            `protobuf:"bytes,5,opt,name=database,proto3" json:"database,omitempty"`
	BasicAuthEnabled        bool              `protobuf:"varint,6,opt,name=basicAuthEnabled,proto3" json:"basicAuthEnabled,omitempty"`
	BasicAuthUser           string            `protobuf:"bytes,7,opt,name=basicAuthUser,proto3" json:"basicAuthUser,omitempty"`
	JsonData                []byte            `protobuf:"bytes,8,opt,name=jsonData,proto3" json:"jsonData,omitempty"`
	DecryptedSecureJsonData map[string]string `` /* 187-byte string literal not displayed */
	LastUpdatedMS           int64             `protobuf:"varint,10,opt,name=lastUpdatedMS,proto3" json:"lastUpdatedMS,omitempty"`
	Uid                     string            `protobuf:"bytes,11,opt,name=uid,proto3" json:"uid,omitempty"`
	// contains filtered or unexported fields
}

func (*DataSourceInstanceSettings) Descriptor deprecated added in v0.54.0 

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

Deprecated: Use DataSourceInstanceSettings.ProtoReflect.Descriptor instead.

func (*DataSourceInstanceSettings) GetBasicAuthEnabled added in v0.54.0 

func (x *DataSourceInstanceSettings) GetBasicAuthEnabled() bool

func (*DataSourceInstanceSettings) GetBasicAuthUser added in v0.54.0 

func (x *DataSourceInstanceSettings) GetBasicAuthUser() string

func (*DataSourceInstanceSettings) GetDatabase added in v0.54.0 

func (x *DataSourceInstanceSettings) GetDatabase() string

func (*DataSourceInstanceSettings) GetDecryptedSecureJsonData added in v0.54.0 

func (x *DataSourceInstanceSettings) GetDecryptedSecureJsonData() map[string]string

func (*DataSourceInstanceSettings) GetId added in v0.54.0 

func (x *DataSourceInstanceSettings) GetId() int64

func (*DataSourceInstanceSettings) GetJsonData added in v0.54.0 

func (x *DataSourceInstanceSettings) GetJsonData() []byte

func (*DataSourceInstanceSettings) GetLastUpdatedMS added in v0.54.0 

func (x *DataSourceInstanceSettings) GetLastUpdatedMS() int64

func (*DataSourceInstanceSettings) GetName added in v0.54.0 

func (x *DataSourceInstanceSettings) GetName() string

func (*DataSourceInstanceSettings) GetUid added in v0.82.0 

func (x *DataSourceInstanceSettings) GetUid() string

func (*DataSourceInstanceSettings) GetUrl added in v0.54.0 

func (x *DataSourceInstanceSettings) GetUrl() string

func (*DataSourceInstanceSettings) GetUser added in v0.54.0 

func (x *DataSourceInstanceSettings) GetUser() string

func (*DataSourceInstanceSettings) ProtoMessage added in v0.54.0 

func (*DataSourceInstanceSettings) ProtoMessage()

func (*DataSourceInstanceSettings) ProtoReflect added in v0.87.0 

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

func (*DataSourceInstanceSettings) Reset added in v0.54.0 

func (x *DataSourceInstanceSettings) Reset()

func (*DataSourceInstanceSettings) String added in v0.54.0 

func (x *DataSourceInstanceSettings) String() string

type DiagnosticsClient 

type DiagnosticsClient interface {
	CheckHealth(ctx context.Context, in *CheckHealthRequest, opts ...grpc.CallOption) (*CheckHealthResponse, error)
	CollectMetrics(ctx context.Context, in *CollectMetricsRequest, opts ...grpc.CallOption) (*CollectMetricsResponse, error)
}

DiagnosticsClient is the client API for Diagnostics 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 NewDiagnosticsClient 

func NewDiagnosticsClient(cc grpc.ClientConnInterface) DiagnosticsClient

type DiagnosticsServer 

type DiagnosticsServer interface {
	CheckHealth(context.Context, *CheckHealthRequest) (*CheckHealthResponse, error)
	CollectMetrics(context.Context, *CollectMetricsRequest) (*CollectMetricsResponse, error)
}

DiagnosticsServer is the server API for Diagnostics service. All implementations should embed UnimplementedDiagnosticsServer for forward compatibility

type PluginContext added in v0.54.0 

type PluginContext struct {

	// The Grafana organization id the request originating from.
	OrgId int64 `protobuf:"varint,1,opt,name=orgId,proto3" json:"orgId,omitempty"`
	// The unique identifier of the plugin the request  originating from.
	PluginId string `protobuf:"bytes,2,opt,name=pluginId,proto3" json:"pluginId,omitempty"`
	// The Grafana user the request originating from.
	//
	// Will not be provided if Grafana backend initiated the request.
	User *User `protobuf:"bytes,3,opt,name=user,proto3" json:"user,omitempty"`
	// App plugin instance settings is the configured app instance settings.
	// In Grafana an app instance is an enabled app plugin in a
	// Grafana organization.
	//
	// Will only be set if request targeting an app instance.
	AppInstanceSettings *AppInstanceSettings `protobuf:"bytes,4,opt,name=appInstanceSettings,proto3" json:"appInstanceSettings,omitempty"`
	// Data source instance settings is the configured data source instance
	// settings. In Grafana a data source instance is a created data source
	// in a Grafana organization.
	//
	// Will only be set if request targeting a data source instance.
	DataSourceInstanceSettings *DataSourceInstanceSettings `protobuf:"bytes,5,opt,name=dataSourceInstanceSettings,proto3" json:"dataSourceInstanceSettings,omitempty"`
	// contains filtered or unexported fields
}

func (*PluginContext) Descriptor deprecated added in v0.54.0 

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

Deprecated: Use PluginContext.ProtoReflect.Descriptor instead.

func (*PluginContext) GetAppInstanceSettings added in v0.54.0 

func (x *PluginContext) GetAppInstanceSettings() *AppInstanceSettings

func (*PluginContext) GetDataSourceInstanceSettings added in v0.54.0 

func (x *PluginContext) GetDataSourceInstanceSettings() *DataSourceInstanceSettings

func (*PluginContext) GetOrgId added in v0.54.0 

func (x *PluginContext) GetOrgId() int64

func (*PluginContext) GetPluginId added in v0.54.0 

func (x *PluginContext) GetPluginId() string

func (*PluginContext) GetUser added in v0.54.0 

func (x *PluginContext) GetUser() *User

func (*PluginContext) ProtoMessage added in v0.54.0 

func (*PluginContext) ProtoMessage()

func (*PluginContext) ProtoReflect added in v0.87.0 

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

func (*PluginContext) Reset added in v0.54.0 

func (x *PluginContext) Reset()

func (*PluginContext) String added in v0.54.0 

func (x *PluginContext) String() string

type QueryDataRequest 

type QueryDataRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// Environment info
	Headers map[string]string `` /* 155-byte string literal not displayed */
	// List of data queries
	Queries []*DataQuery `protobuf:"bytes,3,rep,name=queries,proto3" json:"queries,omitempty"`
	// contains filtered or unexported fields
}

QueryDataRequest

func (*QueryDataRequest) Descriptor deprecated 

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

Deprecated: Use QueryDataRequest.ProtoReflect.Descriptor instead.

func (*QueryDataRequest) GetHeaders 

func (x *QueryDataRequest) GetHeaders() map[string]string

func (*QueryDataRequest) GetPluginContext added in v0.54.0 

func (x *QueryDataRequest) GetPluginContext() *PluginContext

func (*QueryDataRequest) GetQueries 

func (x *QueryDataRequest) GetQueries() []*DataQuery

func (*QueryDataRequest) ProtoMessage 

func (*QueryDataRequest) ProtoMessage()

func (*QueryDataRequest) ProtoReflect added in v0.87.0 

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

func (*QueryDataRequest) Reset 

func (x *QueryDataRequest) Reset()

func (*QueryDataRequest) String 

func (x *QueryDataRequest) String() string

type QueryDataResponse 

type QueryDataResponse struct {

	// Map of refId to response
	Responses map[string]*DataResponse `` /* 159-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*QueryDataResponse) Descriptor deprecated 

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

Deprecated: Use QueryDataResponse.ProtoReflect.Descriptor instead.

func (*QueryDataResponse) GetResponses added in v0.35.0 

func (x *QueryDataResponse) GetResponses() map[string]*DataResponse

func (*QueryDataResponse) ProtoMessage 

func (*QueryDataResponse) ProtoMessage()

func (*QueryDataResponse) ProtoReflect added in v0.87.0 

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

func (*QueryDataResponse) Reset 

func (x *QueryDataResponse) Reset()

func (*QueryDataResponse) String 

func (x *QueryDataResponse) String() string

type ResourceClient 

type ResourceClient interface {
	CallResource(ctx context.Context, in *CallResourceRequest, opts ...grpc.CallOption) (Resource_CallResourceClient, error)
}

ResourceClient is the client API for Resource 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 NewResourceClient 

func NewResourceClient(cc grpc.ClientConnInterface) ResourceClient

type ResourceServer 

type ResourceServer interface {
	CallResource(*CallResourceRequest, Resource_CallResourceServer) error
}

ResourceServer is the server API for Resource service. All implementations should embed UnimplementedResourceServer for forward compatibility

type Resource_CallResourceClient 

type Resource_CallResourceClient interface {
	Recv() (*CallResourceResponse, error)
	grpc.ClientStream
}

type Resource_CallResourceServer 

type Resource_CallResourceServer interface {
	Send(*CallResourceResponse) error
	grpc.ServerStream
}

type RunStreamRequest added in v0.89.0 

type RunStreamRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	Path          string         `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*RunStreamRequest) Descriptor deprecated added in v0.89.0 

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

Deprecated: Use RunStreamRequest.ProtoReflect.Descriptor instead.

func (*RunStreamRequest) GetPath added in v0.89.0 

func (x *RunStreamRequest) GetPath() string

func (*RunStreamRequest) GetPluginContext added in v0.89.0 

func (x *RunStreamRequest) GetPluginContext() *PluginContext

func (*RunStreamRequest) ProtoMessage added in v0.89.0 

func (*RunStreamRequest) ProtoMessage()

func (*RunStreamRequest) ProtoReflect added in v0.89.0 

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

func (*RunStreamRequest) Reset added in v0.89.0 

func (x *RunStreamRequest) Reset()

func (*RunStreamRequest) String added in v0.89.0 

func (x *RunStreamRequest) String() string

type StreamClient added in v0.89.0 

type StreamClient interface {
	// Called when a user tries to connect to a plugin/datasource managed channel.
	CanSubscribeToStream(ctx context.Context, in *SubscribeToStreamRequest, opts ...grpc.CallOption) (*SubscribeToStreamResponse, error)
	// RunStream will be initiated by Grafana to consume a stream from a plugin.
	// For streams with keepalive set this will only be called once the first client
	// successfully subscribed to a stream channel. And when there are no longer any
	// subscribers, the call will be terminated by Grafana.
	RunStream(ctx context.Context, in *RunStreamRequest, opts ...grpc.CallOption) (Stream_RunStreamClient, error)
}

StreamClient is the client API for Stream 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 NewStreamClient added in v0.89.0 

func NewStreamClient(cc grpc.ClientConnInterface) StreamClient

type StreamPacket added in v0.89.0 

type StreamPacket struct {
	Type    StreamPacket_StreamPacketType `protobuf:"varint,1,opt,name=type,proto3,enum=pluginv2.StreamPacket_StreamPacketType" json:"type,omitempty"`
	Header  []byte                        `protobuf:"bytes,2,opt,name=header,proto3" json:"header,omitempty"`
	Payload []byte                        `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamPacket) Descriptor deprecated added in v0.89.0 

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

Deprecated: Use StreamPacket.ProtoReflect.Descriptor instead.

func (*StreamPacket) GetHeader added in v0.89.0 

func (x *StreamPacket) GetHeader() []byte

func (*StreamPacket) GetPayload added in v0.89.0 

func (x *StreamPacket) GetPayload() []byte

func (*StreamPacket) GetType added in v0.89.0 

func (x *StreamPacket) GetType() StreamPacket_StreamPacketType

func (*StreamPacket) ProtoMessage added in v0.89.0 

func (*StreamPacket) ProtoMessage()

func (*StreamPacket) ProtoReflect added in v0.89.0 

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

func (*StreamPacket) Reset added in v0.89.0 

func (x *StreamPacket) Reset()

func (*StreamPacket) String added in v0.89.0 

func (x *StreamPacket) String() string

type StreamPacket_StreamPacketType added in v0.89.0 

type StreamPacket_StreamPacketType int32
const (
	StreamPacket_DATA_FRAME StreamPacket_StreamPacketType = 0
)

func (StreamPacket_StreamPacketType) Descriptor added in v0.89.0 

func (StreamPacket_StreamPacketType) Descriptor() protoreflect.EnumDescriptor

func (StreamPacket_StreamPacketType) Enum added in v0.89.0 

func (x StreamPacket_StreamPacketType) Enum() *StreamPacket_StreamPacketType

func (StreamPacket_StreamPacketType) EnumDescriptor deprecated added in v0.89.0 

func (StreamPacket_StreamPacketType) EnumDescriptor() ([]byte, []int)

Deprecated: Use StreamPacket_StreamPacketType.Descriptor instead.

func (StreamPacket_StreamPacketType) Number added in v0.89.0 

func (x StreamPacket_StreamPacketType) Number() protoreflect.EnumNumber

func (StreamPacket_StreamPacketType) String added in v0.89.0 

func (x StreamPacket_StreamPacketType) String() string

func (StreamPacket_StreamPacketType) Type added in v0.89.0 

func (StreamPacket_StreamPacketType) Type() protoreflect.EnumType

type StreamServer added in v0.89.0 

type StreamServer interface {
	// Called when a user tries to connect to a plugin/datasource managed channel.
	CanSubscribeToStream(context.Context, *SubscribeToStreamRequest) (*SubscribeToStreamResponse, error)
	// RunStream will be initiated by Grafana to consume a stream from a plugin.
	// For streams with keepalive set this will only be called once the first client
	// successfully subscribed to a stream channel. And when there are no longer any
	// subscribers, the call will be terminated by Grafana.
	RunStream(*RunStreamRequest, Stream_RunStreamServer) error
}

StreamServer is the server API for Stream service. All implementations should embed UnimplementedStreamServer for forward compatibility

type Stream_RunStreamClient added in v0.89.0 

type Stream_RunStreamClient interface {
	Recv() (*StreamPacket, error)
	grpc.ClientStream
}

type Stream_RunStreamServer added in v0.89.0 

type Stream_RunStreamServer interface {
	Send(*StreamPacket) error
	grpc.ServerStream
}

type StringList 

type StringList struct {
	Values []string `protobuf:"bytes,1,rep,name=values,proto3" json:"values,omitempty"`
	// contains filtered or unexported fields
}

func (*StringList) Descriptor deprecated 

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

Deprecated: Use StringList.ProtoReflect.Descriptor instead.

func (*StringList) GetValues 

func (x *StringList) GetValues() []string

func (*StringList) ProtoMessage 

func (*StringList) ProtoMessage()

func (*StringList) ProtoReflect added in v0.87.0 

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

func (*StringList) Reset 

func (x *StringList) Reset()

func (*StringList) String 

func (x *StringList) String() string

type SubscribeToStreamRequest added in v0.89.0 

type SubscribeToStreamRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	Path          string         `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeToStreamRequest) Descriptor deprecated added in v0.89.0 

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

Deprecated: Use SubscribeToStreamRequest.ProtoReflect.Descriptor instead.

func (*SubscribeToStreamRequest) GetPath added in v0.89.0 

func (x *SubscribeToStreamRequest) GetPath() string

func (*SubscribeToStreamRequest) GetPluginContext added in v0.89.0 

func (x *SubscribeToStreamRequest) GetPluginContext() *PluginContext

func (*SubscribeToStreamRequest) ProtoMessage added in v0.89.0 

func (*SubscribeToStreamRequest) ProtoMessage()

func (*SubscribeToStreamRequest) ProtoReflect added in v0.89.0 

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

func (*SubscribeToStreamRequest) Reset added in v0.89.0 

func (x *SubscribeToStreamRequest) Reset()

func (*SubscribeToStreamRequest) String added in v0.89.0 

func (x *SubscribeToStreamRequest) String() string

type SubscribeToStreamResponse added in v0.89.0 

type SubscribeToStreamResponse struct {
	Ok      bool   `protobuf:"varint,1,opt,name=ok,proto3" json:"ok,omitempty"`
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeToStreamResponse) Descriptor deprecated added in v0.89.0 

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

Deprecated: Use SubscribeToStreamResponse.ProtoReflect.Descriptor instead.

func (*SubscribeToStreamResponse) GetMessage added in v0.89.0 

func (x *SubscribeToStreamResponse) GetMessage() string

func (*SubscribeToStreamResponse) GetOk added in v0.89.0 

func (x *SubscribeToStreamResponse) GetOk() bool

func (*SubscribeToStreamResponse) ProtoMessage added in v0.89.0 

func (*SubscribeToStreamResponse) ProtoMessage()

func (*SubscribeToStreamResponse) ProtoReflect added in v0.89.0 

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

func (*SubscribeToStreamResponse) Reset added in v0.89.0 

func (x *SubscribeToStreamResponse) Reset()

func (*SubscribeToStreamResponse) String added in v0.89.0 

func (x *SubscribeToStreamResponse) String() string

type TimeRange 

type TimeRange struct {
	FromEpochMS int64 `protobuf:"varint,1,opt,name=fromEpochMS,proto3" json:"fromEpochMS,omitempty"`
	ToEpochMS   int64 `protobuf:"varint,2,opt,name=toEpochMS,proto3" json:"toEpochMS,omitempty"`
	// contains filtered or unexported fields
}

func (*TimeRange) Descriptor deprecated 

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

Deprecated: Use TimeRange.ProtoReflect.Descriptor instead.

func (*TimeRange) GetFromEpochMS 

func (x *TimeRange) GetFromEpochMS() int64

func (*TimeRange) GetToEpochMS 

func (x *TimeRange) GetToEpochMS() int64

func (*TimeRange) ProtoMessage 

func (*TimeRange) ProtoMessage()

func (*TimeRange) ProtoReflect added in v0.87.0 

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

func (*TimeRange) Reset 

func (x *TimeRange) Reset()

func (*TimeRange) String 

func (x *TimeRange) String() string

type UnimplementedDataServer 

type UnimplementedDataServer struct {
}

UnimplementedDataServer should be embedded to have forward compatible implementations.

func (UnimplementedDataServer) QueryData 

func (UnimplementedDataServer) QueryData(context.Context, *QueryDataRequest) (*QueryDataResponse, error)

type UnimplementedDiagnosticsServer 

type UnimplementedDiagnosticsServer struct {
}

UnimplementedDiagnosticsServer should be embedded to have forward compatible implementations.

func (UnimplementedDiagnosticsServer) CheckHealth 

func (UnimplementedDiagnosticsServer) CheckHealth(context.Context, *CheckHealthRequest) (*CheckHealthResponse, error)

func (UnimplementedDiagnosticsServer) CollectMetrics 

func (UnimplementedDiagnosticsServer) CollectMetrics(context.Context, *CollectMetricsRequest) (*CollectMetricsResponse, error)

type UnimplementedResourceServer 

type UnimplementedResourceServer struct {
}

UnimplementedResourceServer should be embedded to have forward compatible implementations.

func (UnimplementedResourceServer) CallResource 

func (UnimplementedResourceServer) CallResource(*CallResourceRequest, Resource_CallResourceServer) error

type UnimplementedStreamServer added in v0.89.0 

type UnimplementedStreamServer struct {
}

UnimplementedStreamServer should be embedded to have forward compatible implementations.

func (UnimplementedStreamServer) CanSubscribeToStream added in v0.89.0 

func (UnimplementedStreamServer) CanSubscribeToStream(context.Context, *SubscribeToStreamRequest) (*SubscribeToStreamResponse, error)

func (UnimplementedStreamServer) RunStream added in v0.89.0 

func (UnimplementedStreamServer) RunStream(*RunStreamRequest, Stream_RunStreamServer) error

type UnsafeDataServer added in v0.87.0 

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

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

type UnsafeDiagnosticsServer added in v0.87.0 

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

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

type UnsafeResourceServer added in v0.87.0 

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

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

type UnsafeStreamServer added in v0.89.0 

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

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

type User 

type User struct {
	Login string `protobuf:"bytes,1,opt,name=login,proto3" json:"login,omitempty"`
	Name  string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	Email string `protobuf:"bytes,3,opt,name=email,proto3" json:"email,omitempty"`
	Role  string `protobuf:"bytes,4,opt,name=role,proto3" json:"role,omitempty"`
	// contains filtered or unexported fields
}

func (*User) Descriptor deprecated 

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

Deprecated: Use User.ProtoReflect.Descriptor instead.

func (*User) GetEmail 

func (x *User) GetEmail() string

func (*User) GetLogin 

func (x *User) GetLogin() string

func (*User) GetName 

func (x *User) GetName() string

func (*User) GetRole 

func (x *User) GetRole() string

func (*User) ProtoMessage 

func (*User) ProtoMessage()

func (*User) ProtoReflect added in v0.87.0 

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

func (*User) Reset 

func (x *User) Reset()

func (*User) String 

func (x *User) String() string

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.