pluginv2

package
v0.999.0 Latest Latest
Warning

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

Go to latest
Published: Apr 20, 2022 License: Apache-2.0 Imports: 8 Imported by: 0

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 (
	SubscribeStreamResponse_Status_name = map[int32]string{
		0: "OK",
		1: "NOT_FOUND",
		2: "PERMISSION_DENIED",
	}
	SubscribeStreamResponse_Status_value = map[string]int32{
		"OK":                0,
		"NOT_FOUND":         1,
		"PERMISSION_DENIED": 2,
	}
)

Enum value maps for SubscribeStreamResponse_Status.

View Source
var (
	PublishStreamResponse_Status_name = map[int32]string{
		0: "OK",
		1: "NOT_FOUND",
		2: "PERMISSION_DENIED",
	}
	PublishStreamResponse_Status_value = map[string]int32{
		"OK":                0,
		"NOT_FOUND":         1,
		"PERMISSION_DENIED": 2,
	}
)

Enum value maps for PublishStreamResponse_Status.

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: "SubscribeStream",
			Handler:    _Stream_SubscribeStream_Handler,
		},
		{
			MethodName: "PublishStream",
			Handler:    _Stream_PublishStream_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

func RegisterStreamServer(s grpc.ServiceRegistrar, srv StreamServer)

Types

type AppInstanceSettings

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

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

Deprecated: Use AppInstanceSettings.ProtoReflect.Descriptor instead.

func (*AppInstanceSettings) GetDecryptedSecureJsonData

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

func (*AppInstanceSettings) GetJsonData

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

func (*AppInstanceSettings) GetLastUpdatedMS

func (x *AppInstanceSettings) GetLastUpdatedMS() int64

func (*AppInstanceSettings) ProtoMessage

func (*AppInstanceSettings) ProtoMessage()

func (*AppInstanceSettings) ProtoReflect

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

func (*AppInstanceSettings) Reset

func (x *AppInstanceSettings) Reset()

func (*AppInstanceSettings) String

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

func (x *CallResourceRequest) GetPluginContext() *PluginContext

func (*CallResourceRequest) GetUrl

func (x *CallResourceRequest) GetUrl() string

func (*CallResourceRequest) ProtoMessage

func (*CallResourceRequest) ProtoMessage()

func (*CallResourceRequest) ProtoReflect

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

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

func (x *CheckHealthRequest) GetPluginContext() *PluginContext

func (*CheckHealthRequest) ProtoMessage

func (*CheckHealthRequest) ProtoMessage()

func (*CheckHealthRequest) ProtoReflect

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 (*CheckHealthResponse) ProtoMessage

func (*CheckHealthResponse) ProtoMessage()

func (*CheckHealthResponse) ProtoReflect

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

func (CheckHealthResponse_HealthStatus) Enum

func (CheckHealthResponse_HealthStatus) EnumDescriptor deprecated

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

Deprecated: Use CheckHealthResponse_HealthStatus.Descriptor instead.

func (CheckHealthResponse_HealthStatus) Number

func (CheckHealthResponse_HealthStatus) String

func (CheckHealthResponse_HealthStatus) Type

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

func (x *CollectMetricsRequest) GetPluginContext() *PluginContext

func (*CollectMetricsRequest) ProtoMessage

func (*CollectMetricsRequest) ProtoMessage()

func (*CollectMetricsRequest) ProtoReflect

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 (*CollectMetricsResponse) ProtoMessage

func (*CollectMetricsResponse) ProtoMessage()

func (*CollectMetricsResponse) ProtoReflect

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

func (*CollectMetricsResponse_Payload) Reset

func (x *CollectMetricsResponse_Payload) Reset()

func (*CollectMetricsResponse_Payload) 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

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

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

func (*DataQuery) Reset

func (x *DataQuery) Reset()

func (*DataQuery) String

func (x *DataQuery) String() string

type DataResponse

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

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

Deprecated: Use DataResponse.ProtoReflect.Descriptor instead.

func (*DataResponse) GetError

func (x *DataResponse) GetError() string

func (*DataResponse) GetFrames

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

func (*DataResponse) GetJsonMeta

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

func (*DataResponse) ProtoMessage

func (*DataResponse) ProtoMessage()

func (*DataResponse) ProtoReflect

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

func (*DataResponse) Reset

func (x *DataResponse) Reset()

func (*DataResponse) String

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

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

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

Deprecated: Use DataSourceInstanceSettings.ProtoReflect.Descriptor instead.

func (*DataSourceInstanceSettings) GetBasicAuthEnabled

func (x *DataSourceInstanceSettings) GetBasicAuthEnabled() bool

func (*DataSourceInstanceSettings) GetBasicAuthUser

func (x *DataSourceInstanceSettings) GetBasicAuthUser() string

func (*DataSourceInstanceSettings) GetDatabase

func (x *DataSourceInstanceSettings) GetDatabase() string

func (*DataSourceInstanceSettings) GetDecryptedSecureJsonData

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

func (*DataSourceInstanceSettings) GetId

func (x *DataSourceInstanceSettings) GetId() int64

func (*DataSourceInstanceSettings) GetJsonData

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

func (*DataSourceInstanceSettings) GetLastUpdatedMS

func (x *DataSourceInstanceSettings) GetLastUpdatedMS() int64

func (*DataSourceInstanceSettings) GetName

func (x *DataSourceInstanceSettings) GetName() string

func (*DataSourceInstanceSettings) GetUid

func (x *DataSourceInstanceSettings) GetUid() string

func (*DataSourceInstanceSettings) GetUrl

func (x *DataSourceInstanceSettings) GetUrl() string

func (*DataSourceInstanceSettings) GetUser

func (x *DataSourceInstanceSettings) GetUser() string

func (*DataSourceInstanceSettings) ProtoMessage

func (*DataSourceInstanceSettings) ProtoMessage()

func (*DataSourceInstanceSettings) ProtoReflect

func (*DataSourceInstanceSettings) Reset

func (x *DataSourceInstanceSettings) Reset()

func (*DataSourceInstanceSettings) String

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.

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

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

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

Deprecated: Use PluginContext.ProtoReflect.Descriptor instead.

func (*PluginContext) GetAppInstanceSettings

func (x *PluginContext) GetAppInstanceSettings() *AppInstanceSettings

func (*PluginContext) GetDataSourceInstanceSettings

func (x *PluginContext) GetDataSourceInstanceSettings() *DataSourceInstanceSettings

func (*PluginContext) GetOrgId

func (x *PluginContext) GetOrgId() int64

func (*PluginContext) GetPluginId

func (x *PluginContext) GetPluginId() string

func (*PluginContext) GetUser

func (x *PluginContext) GetUser() *User

func (*PluginContext) ProtoMessage

func (*PluginContext) ProtoMessage()

func (*PluginContext) ProtoReflect

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

func (*PluginContext) Reset

func (x *PluginContext) Reset()

func (*PluginContext) String

func (x *PluginContext) String() string

type PublishStreamRequest

type PublishStreamRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// path part of a channel.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// data that user wants to publish into a stream
	// (only JSON-encoded at the moment).
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishStreamRequest) Descriptor deprecated

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

Deprecated: Use PublishStreamRequest.ProtoReflect.Descriptor instead.

func (*PublishStreamRequest) GetData

func (x *PublishStreamRequest) GetData() []byte

func (*PublishStreamRequest) GetPath

func (x *PublishStreamRequest) GetPath() string

func (*PublishStreamRequest) GetPluginContext

func (x *PublishStreamRequest) GetPluginContext() *PluginContext

func (*PublishStreamRequest) ProtoMessage

func (*PublishStreamRequest) ProtoMessage()

func (*PublishStreamRequest) ProtoReflect

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

func (*PublishStreamRequest) Reset

func (x *PublishStreamRequest) Reset()

func (*PublishStreamRequest) String

func (x *PublishStreamRequest) String() string

type PublishStreamResponse

type PublishStreamResponse struct {

	// status of publish response.
	Status PublishStreamResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=pluginv2.PublishStreamResponse_Status" json:"status,omitempty"`
	// JSON-encoded data to publish into a channel. This can be
	// unmodified data from a PublishRequest or any modified data.
	// If empty data returned here then Grafana won't publish data
	// to a channel itself but will return a successful result to a
	// client (supposing plugin published data to a channel itself).
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*PublishStreamResponse) Descriptor deprecated

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

Deprecated: Use PublishStreamResponse.ProtoReflect.Descriptor instead.

func (*PublishStreamResponse) GetData

func (x *PublishStreamResponse) GetData() []byte

func (*PublishStreamResponse) GetStatus

func (*PublishStreamResponse) ProtoMessage

func (*PublishStreamResponse) ProtoMessage()

func (*PublishStreamResponse) ProtoReflect

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

func (*PublishStreamResponse) Reset

func (x *PublishStreamResponse) Reset()

func (*PublishStreamResponse) String

func (x *PublishStreamResponse) String() string

type PublishStreamResponse_Status

type PublishStreamResponse_Status int32
const (
	PublishStreamResponse_OK                PublishStreamResponse_Status = 0
	PublishStreamResponse_NOT_FOUND         PublishStreamResponse_Status = 1
	PublishStreamResponse_PERMISSION_DENIED PublishStreamResponse_Status = 2
)

func (PublishStreamResponse_Status) Descriptor

func (PublishStreamResponse_Status) Enum

func (PublishStreamResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use PublishStreamResponse_Status.Descriptor instead.

func (PublishStreamResponse_Status) Number

func (PublishStreamResponse_Status) String

func (PublishStreamResponse_Status) Type

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

func (x *QueryDataRequest) GetPluginContext() *PluginContext

func (*QueryDataRequest) GetQueries

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

func (*QueryDataRequest) ProtoMessage

func (*QueryDataRequest) ProtoMessage()

func (*QueryDataRequest) ProtoReflect

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

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

func (*QueryDataResponse) ProtoMessage

func (*QueryDataResponse) ProtoMessage()

func (*QueryDataResponse) ProtoReflect

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

type RunStreamRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// path part of a channel.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// optional raw data. May be used as an extra payload supplied upon subscription.
	// For example, can contain JSON query object.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*RunStreamRequest) Descriptor deprecated

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

Deprecated: Use RunStreamRequest.ProtoReflect.Descriptor instead.

func (*RunStreamRequest) GetData

func (x *RunStreamRequest) GetData() []byte

func (*RunStreamRequest) GetPath

func (x *RunStreamRequest) GetPath() string

func (*RunStreamRequest) GetPluginContext

func (x *RunStreamRequest) GetPluginContext() *PluginContext

func (*RunStreamRequest) ProtoMessage

func (*RunStreamRequest) ProtoMessage()

func (*RunStreamRequest) ProtoReflect

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

func (*RunStreamRequest) Reset

func (x *RunStreamRequest) Reset()

func (*RunStreamRequest) String

func (x *RunStreamRequest) String() string

type StreamClient

type StreamClient interface {
	// SubscribeStream called when a user tries to subscribe to a plugin/datasource
	// managed channel path – thus plugin can check subscribe permissions and communicate
	// options with Grafana Core. When the first subscriber joins a channel, RunStream
	// will be called.
	SubscribeStream(ctx context.Context, in *SubscribeStreamRequest, opts ...grpc.CallOption) (*SubscribeStreamResponse, error)
	// RunStream will be initiated by Grafana to consume a stream. RunStream will be
	// called once for the first client successfully subscribed to a channel path.
	// When Grafana detects that there are no longer any subscribers inside a channel,
	// the call will be terminated until next active subscriber appears. Call termination
	// can happen with a delay.
	RunStream(ctx context.Context, in *RunStreamRequest, opts ...grpc.CallOption) (Stream_RunStreamClient, error)
	// PublishStream called when a user tries to publish to a plugin/datasource
	// managed channel path. Here plugin can check publish permissions and
	// modify publication data if required.
	PublishStream(ctx context.Context, in *PublishStreamRequest, opts ...grpc.CallOption) (*PublishStreamResponse, 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

func NewStreamClient(cc grpc.ClientConnInterface) StreamClient

type StreamPacket

type StreamPacket struct {

	// JSON-encoded data to publish into a channel.
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*StreamPacket) Descriptor deprecated

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

Deprecated: Use StreamPacket.ProtoReflect.Descriptor instead.

func (*StreamPacket) GetData

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

func (*StreamPacket) ProtoMessage

func (*StreamPacket) ProtoMessage()

func (*StreamPacket) ProtoReflect

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

func (*StreamPacket) Reset

func (x *StreamPacket) Reset()

func (*StreamPacket) String

func (x *StreamPacket) String() string

type StreamServer

type StreamServer interface {
	// SubscribeStream called when a user tries to subscribe to a plugin/datasource
	// managed channel path – thus plugin can check subscribe permissions and communicate
	// options with Grafana Core. When the first subscriber joins a channel, RunStream
	// will be called.
	SubscribeStream(context.Context, *SubscribeStreamRequest) (*SubscribeStreamResponse, error)
	// RunStream will be initiated by Grafana to consume a stream. RunStream will be
	// called once for the first client successfully subscribed to a channel path.
	// When Grafana detects that there are no longer any subscribers inside a channel,
	// the call will be terminated until next active subscriber appears. Call termination
	// can happen with a delay.
	RunStream(*RunStreamRequest, Stream_RunStreamServer) error
	// PublishStream called when a user tries to publish to a plugin/datasource
	// managed channel path. Here plugin can check publish permissions and
	// modify publication data if required.
	PublishStream(context.Context, *PublishStreamRequest) (*PublishStreamResponse, error)
}

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

type Stream_RunStreamClient

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

type Stream_RunStreamServer

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

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

func (*StringList) Reset

func (x *StringList) Reset()

func (*StringList) String

func (x *StringList) String() string

type SubscribeStreamRequest

type SubscribeStreamRequest struct {
	PluginContext *PluginContext `protobuf:"bytes,1,opt,name=pluginContext,proto3" json:"pluginContext,omitempty"`
	// path part of channel.
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// optional raw data. May be used as an extra payload supplied upon subscription.
	// For example, can contain JSON query object.
	Data []byte `protobuf:"bytes,3,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeStreamRequest) Descriptor deprecated

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

Deprecated: Use SubscribeStreamRequest.ProtoReflect.Descriptor instead.

func (*SubscribeStreamRequest) GetData

func (x *SubscribeStreamRequest) GetData() []byte

func (*SubscribeStreamRequest) GetPath

func (x *SubscribeStreamRequest) GetPath() string

func (*SubscribeStreamRequest) GetPluginContext

func (x *SubscribeStreamRequest) GetPluginContext() *PluginContext

func (*SubscribeStreamRequest) ProtoMessage

func (*SubscribeStreamRequest) ProtoMessage()

func (*SubscribeStreamRequest) ProtoReflect

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

func (*SubscribeStreamRequest) Reset

func (x *SubscribeStreamRequest) Reset()

func (*SubscribeStreamRequest) String

func (x *SubscribeStreamRequest) String() string

type SubscribeStreamResponse

type SubscribeStreamResponse struct {

	// status of subscribe response.
	Status SubscribeStreamResponse_Status `protobuf:"varint,1,opt,name=status,proto3,enum=pluginv2.SubscribeStreamResponse_Status" json:"status,omitempty"`
	// JSON-encoded data to return to a client in a successful
	// subscription result.
	// For data frame streams this can be a JSON-encoded frame schema.
	Data []byte `protobuf:"bytes,2,opt,name=data,proto3" json:"data,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscribeStreamResponse) Descriptor deprecated

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

Deprecated: Use SubscribeStreamResponse.ProtoReflect.Descriptor instead.

func (*SubscribeStreamResponse) GetData

func (x *SubscribeStreamResponse) GetData() []byte

func (*SubscribeStreamResponse) GetStatus

func (*SubscribeStreamResponse) ProtoMessage

func (*SubscribeStreamResponse) ProtoMessage()

func (*SubscribeStreamResponse) ProtoReflect

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

func (*SubscribeStreamResponse) Reset

func (x *SubscribeStreamResponse) Reset()

func (*SubscribeStreamResponse) String

func (x *SubscribeStreamResponse) String() string

type SubscribeStreamResponse_Status

type SubscribeStreamResponse_Status int32
const (
	SubscribeStreamResponse_OK                SubscribeStreamResponse_Status = 0
	SubscribeStreamResponse_NOT_FOUND         SubscribeStreamResponse_Status = 1
	SubscribeStreamResponse_PERMISSION_DENIED SubscribeStreamResponse_Status = 2
)

func (SubscribeStreamResponse_Status) Descriptor

func (SubscribeStreamResponse_Status) Enum

func (SubscribeStreamResponse_Status) EnumDescriptor deprecated

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

Deprecated: Use SubscribeStreamResponse_Status.Descriptor instead.

func (SubscribeStreamResponse_Status) Number

func (SubscribeStreamResponse_Status) String

func (SubscribeStreamResponse_Status) Type

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

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

type UnimplementedDiagnosticsServer

type UnimplementedDiagnosticsServer struct {
}

UnimplementedDiagnosticsServer should be embedded to have forward compatible implementations.

func (UnimplementedDiagnosticsServer) CheckHealth

func (UnimplementedDiagnosticsServer) CollectMetrics

type UnimplementedResourceServer

type UnimplementedResourceServer struct {
}

UnimplementedResourceServer should be embedded to have forward compatible implementations.

func (UnimplementedResourceServer) CallResource

type UnimplementedStreamServer

type UnimplementedStreamServer struct {
}

UnimplementedStreamServer should be embedded to have forward compatible implementations.

func (UnimplementedStreamServer) PublishStream

func (UnimplementedStreamServer) RunStream

func (UnimplementedStreamServer) SubscribeStream

type UnsafeDataServer

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

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

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

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

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

func (*User) Reset

func (x *User) Reset()

func (*User) String

func (x *User) String() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL