proto

package
v0.14.2 Latest Latest
Warning

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

 Go to latest Published: Mar 5, 2026 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	Cloudprober_AddProbe_FullMethodName         = "/cloudprober.Cloudprober/AddProbe"
	Cloudprober_RemoveProbe_FullMethodName      = "/cloudprober.Cloudprober/RemoveProbe"
	Cloudprober_RunProbe_FullMethodName         = "/cloudprober.Cloudprober/RunProbe"
	Cloudprober_ListProbes_FullMethodName       = "/cloudprober.Cloudprober/ListProbes"
	Cloudprober_SaveProbesConfig_FullMethodName = "/cloudprober.Cloudprober/SaveProbesConfig"
)

Variables

View Source 
var Cloudprober_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "cloudprober.Cloudprober",
	HandlerType: (*CloudproberServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "AddProbe",
			Handler:    _Cloudprober_AddProbe_Handler,
		},
		{
			MethodName: "RemoveProbe",
			Handler:    _Cloudprober_RemoveProbe_Handler,
		},
		{
			MethodName: "RunProbe",
			Handler:    _Cloudprober_RunProbe_Handler,
		},
		{
			MethodName: "ListProbes",
			Handler:    _Cloudprober_ListProbes_Handler,
		},
		{
			MethodName: "SaveProbesConfig",
			Handler:    _Cloudprober_SaveProbesConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "github.com/cloudprober/cloudprober/prober/proto/service.proto",
}

Cloudprober_ServiceDesc is the grpc.ServiceDesc for Cloudprober 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_github_com_cloudprober_cloudprober_prober_proto_service_proto protoreflect.FileDescriptor

Functions

func RegisterCloudproberServer 

func RegisterCloudproberServer(s grpc.ServiceRegistrar, srv CloudproberServer)

Types

type AddProbeRequest 

type AddProbeRequest struct {
	ProbeConfig *proto.ProbeDef `protobuf:"bytes,1,opt,name=probe_config,json=probeConfig" json:"probe_config,omitempty"`
	// contains filtered or unexported fields
}

func (*AddProbeRequest) Descriptor deprecated 

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

Deprecated: Use AddProbeRequest.ProtoReflect.Descriptor instead.

func (*AddProbeRequest) GetProbeConfig 

func (x *AddProbeRequest) GetProbeConfig() *proto.ProbeDef

func (*AddProbeRequest) ProtoMessage 

func (*AddProbeRequest) ProtoMessage()

func (*AddProbeRequest) ProtoReflect added in v0.11.4 

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

func (*AddProbeRequest) Reset 

func (x *AddProbeRequest) Reset()

func (*AddProbeRequest) String 

func (x *AddProbeRequest) String() string

type AddProbeResponse 

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

func (*AddProbeResponse) Descriptor deprecated 

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

Deprecated: Use AddProbeResponse.ProtoReflect.Descriptor instead.

func (*AddProbeResponse) ProtoMessage 

func (*AddProbeResponse) ProtoMessage()

func (*AddProbeResponse) ProtoReflect added in v0.11.4 

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

func (*AddProbeResponse) Reset 

func (x *AddProbeResponse) Reset()

func (*AddProbeResponse) String 

func (x *AddProbeResponse) String() string

type CloudproberClient 

type CloudproberClient interface {
	// AddProbe adds a probe to cloudprober. Error is returned if probe is already
	// defined or there is an error during initialization of the probe.
	AddProbe(ctx context.Context, in *AddProbeRequest, opts ...grpc.CallOption) (*AddProbeResponse, error)
	// RemoveProbe stops the probe and removes it from the in-memory database.
	RemoveProbe(ctx context.Context, in *RemoveProbeRequest, opts ...grpc.CallOption) (*RemoveProbeResponse, error)
	// EXPERIMENTAL. It's still in development. Implementation subject to change.
	// RunProbe runs all or subset of probes this instance is configured with.
	RunProbe(ctx context.Context, in *RunProbeRequest, opts ...grpc.CallOption) (*RunProbeResponse, error)
	// ListProbes lists active probes.
	ListProbes(ctx context.Context, in *ListProbesRequest, opts ...grpc.CallOption) (*ListProbesResponse, error)
	SaveProbesConfig(ctx context.Context, in *SaveProbesConfigRequest, opts ...grpc.CallOption) (*SaveProbesConfigResponse, error)
}

CloudproberClient is the client API for Cloudprober 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 NewCloudproberClient 

func NewCloudproberClient(cc grpc.ClientConnInterface) CloudproberClient

type CloudproberServer 

type CloudproberServer interface {
	// AddProbe adds a probe to cloudprober. Error is returned if probe is already
	// defined or there is an error during initialization of the probe.
	AddProbe(context.Context, *AddProbeRequest) (*AddProbeResponse, error)
	// RemoveProbe stops the probe and removes it from the in-memory database.
	RemoveProbe(context.Context, *RemoveProbeRequest) (*RemoveProbeResponse, error)
	// EXPERIMENTAL. It's still in development. Implementation subject to change.
	// RunProbe runs all or subset of probes this instance is configured with.
	RunProbe(context.Context, *RunProbeRequest) (*RunProbeResponse, error)
	// ListProbes lists active probes.
	ListProbes(context.Context, *ListProbesRequest) (*ListProbesResponse, error)
	SaveProbesConfig(context.Context, *SaveProbesConfigRequest) (*SaveProbesConfigResponse, error)
	// contains filtered or unexported methods
}

CloudproberServer is the server API for Cloudprober service. All implementations must embed UnimplementedCloudproberServer for forward compatibility.

type ListProbesRequest 

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

func (*ListProbesRequest) Descriptor deprecated 

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

Deprecated: Use ListProbesRequest.ProtoReflect.Descriptor instead.

func (*ListProbesRequest) ProtoMessage 

func (*ListProbesRequest) ProtoMessage()

func (*ListProbesRequest) ProtoReflect added in v0.11.4 

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

func (*ListProbesRequest) Reset 

func (x *ListProbesRequest) Reset()

func (*ListProbesRequest) String 

func (x *ListProbesRequest) String() string

type ListProbesResponse 

type ListProbesResponse struct {
	Probe []*Probe `protobuf:"bytes,1,rep,name=probe" json:"probe,omitempty"`
	// contains filtered or unexported fields
}

func (*ListProbesResponse) Descriptor deprecated 

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

Deprecated: Use ListProbesResponse.ProtoReflect.Descriptor instead.

func (*ListProbesResponse) GetProbe 

func (x *ListProbesResponse) GetProbe() []*Probe

func (*ListProbesResponse) ProtoMessage 

func (*ListProbesResponse) ProtoMessage()

func (*ListProbesResponse) ProtoReflect added in v0.11.4 

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

func (*ListProbesResponse) Reset 

func (x *ListProbesResponse) Reset()

func (*ListProbesResponse) String 

func (x *ListProbesResponse) String() string

type Probe 

type Probe struct {
	Name   *string         `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Config *proto.ProbeDef `protobuf:"bytes,2,opt,name=config" json:"config,omitempty"`
	// contains filtered or unexported fields
}

func (*Probe) Descriptor deprecated 

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

Deprecated: Use Probe.ProtoReflect.Descriptor instead.

func (*Probe) GetConfig 

func (x *Probe) GetConfig() *proto.ProbeDef

func (*Probe) GetName 

func (x *Probe) GetName() string

func (*Probe) ProtoMessage 

func (*Probe) ProtoMessage()

func (*Probe) ProtoReflect added in v0.11.4 

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

func (*Probe) Reset 

func (x *Probe) Reset()

func (*Probe) String 

func (x *Probe) String() string

type ProbeResults added in v0.14.2 

type ProbeResults struct {
	RunResult []*ProbeRunResult `protobuf:"bytes,1,rep,name=run_result,json=runResult" json:"run_result,omitempty"`
	// contains filtered or unexported fields
}

func (*ProbeResults) Descriptor deprecated added in v0.14.2 

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

Deprecated: Use ProbeResults.ProtoReflect.Descriptor instead.

func (*ProbeResults) GetRunResult added in v0.14.2 

func (x *ProbeResults) GetRunResult() []*ProbeRunResult

func (*ProbeResults) ProtoMessage added in v0.14.2 

func (*ProbeResults) ProtoMessage()

func (*ProbeResults) ProtoReflect added in v0.14.2 

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

func (*ProbeResults) Reset added in v0.14.2 

func (x *ProbeResults) Reset()

func (*ProbeResults) String added in v0.14.2 

func (x *ProbeResults) String() string

type ProbeRunResult added in v0.14.2 

type ProbeRunResult struct {

	// Target that this result is associated with.
	Target *proto1.Endpoint `protobuf:"bytes,1,req,name=target" json:"target,omitempty"`
	// True if the probe run was successful.
	Success *bool `protobuf:"varint,2,req,name=success" json:"success,omitempty"`
	// Latency in microseconds. Set for successful probes.
	LatencyUsec *int64 `protobuf:"varint,3,opt,name=latency_usec,json=latencyUsec" json:"latency_usec,omitempty"`
	// Additional metrics from the probe run.
	ResultMetrics []*ResultMetric `protobuf:"bytes,4,rep,name=result_metrics,json=resultMetrics" json:"result_metrics,omitempty"`
	// Optional error message for failed probes.
	Error *string `protobuf:"bytes,5,opt,name=error" json:"error,omitempty"`
	// contains filtered or unexported fields
}

Results of a single probe run for a given target.

func (*ProbeRunResult) Descriptor deprecated added in v0.14.2 

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

Deprecated: Use ProbeRunResult.ProtoReflect.Descriptor instead.

func (*ProbeRunResult) GetError added in v0.14.2 

func (x *ProbeRunResult) GetError() string

func (*ProbeRunResult) GetLatencyUsec added in v0.14.2 

func (x *ProbeRunResult) GetLatencyUsec() int64

func (*ProbeRunResult) GetResultMetrics added in v0.14.2 

func (x *ProbeRunResult) GetResultMetrics() []*ResultMetric

func (*ProbeRunResult) GetSuccess added in v0.14.2 

func (x *ProbeRunResult) GetSuccess() bool

func (*ProbeRunResult) GetTarget added in v0.14.2 

func (x *ProbeRunResult) GetTarget() *proto1.Endpoint

func (*ProbeRunResult) ProtoMessage added in v0.14.2 

func (*ProbeRunResult) ProtoMessage()

func (*ProbeRunResult) ProtoReflect added in v0.14.2 

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

func (*ProbeRunResult) Reset added in v0.14.2 

func (x *ProbeRunResult) Reset()

func (*ProbeRunResult) String added in v0.14.2 

func (x *ProbeRunResult) String() string

type RemoveProbeRequest 

type RemoveProbeRequest struct {
	ProbeName *string `protobuf:"bytes,1,opt,name=probe_name,json=probeName" json:"probe_name,omitempty"`
	// contains filtered or unexported fields
}

func (*RemoveProbeRequest) Descriptor deprecated 

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

Deprecated: Use RemoveProbeRequest.ProtoReflect.Descriptor instead.

func (*RemoveProbeRequest) GetProbeName 

func (x *RemoveProbeRequest) GetProbeName() string

func (*RemoveProbeRequest) ProtoMessage 

func (*RemoveProbeRequest) ProtoMessage()

func (*RemoveProbeRequest) ProtoReflect added in v0.11.4 

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

func (*RemoveProbeRequest) Reset 

func (x *RemoveProbeRequest) Reset()

func (*RemoveProbeRequest) String 

func (x *RemoveProbeRequest) String() string

type RemoveProbeResponse 

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

func (*RemoveProbeResponse) Descriptor deprecated 

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

Deprecated: Use RemoveProbeResponse.ProtoReflect.Descriptor instead.

func (*RemoveProbeResponse) ProtoMessage 

func (*RemoveProbeResponse) ProtoMessage()

func (*RemoveProbeResponse) ProtoReflect added in v0.11.4 

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

func (*RemoveProbeResponse) Reset 

func (x *RemoveProbeResponse) Reset()

func (*RemoveProbeResponse) String 

func (x *RemoveProbeResponse) String() string

type ResultMetric added in v0.14.2 

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

TODO: Add metrics handling.

func (*ResultMetric) Descriptor deprecated added in v0.14.2 

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

Deprecated: Use ResultMetric.ProtoReflect.Descriptor instead.

func (*ResultMetric) ProtoMessage added in v0.14.2 

func (*ResultMetric) ProtoMessage()

func (*ResultMetric) ProtoReflect added in v0.14.2 

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

func (*ResultMetric) Reset added in v0.14.2 

func (x *ResultMetric) Reset()

func (*ResultMetric) String added in v0.14.2 

func (x *ResultMetric) String() string

type RunProbeRequest added in v0.14.2 

type RunProbeRequest struct {

	// If empty, all configured probes are run.
	ProbeName []string `protobuf:"bytes,1,rep,name=probe_name,json=probeName" json:"probe_name,omitempty"`
	// contains filtered or unexported fields
}

func (*RunProbeRequest) Descriptor deprecated added in v0.14.2 

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

Deprecated: Use RunProbeRequest.ProtoReflect.Descriptor instead.

func (*RunProbeRequest) GetProbeName added in v0.14.2 

func (x *RunProbeRequest) GetProbeName() []string

func (*RunProbeRequest) ProtoMessage added in v0.14.2 

func (*RunProbeRequest) ProtoMessage()

func (*RunProbeRequest) ProtoReflect added in v0.14.2 

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

func (*RunProbeRequest) Reset added in v0.14.2 

func (x *RunProbeRequest) Reset()

func (*RunProbeRequest) String added in v0.14.2 

func (x *RunProbeRequest) String() string

type RunProbeResponse added in v0.14.2 

type RunProbeResponse struct {
	Results map[string]*ProbeResults `` /* 134-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*RunProbeResponse) Descriptor deprecated added in v0.14.2 

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

Deprecated: Use RunProbeResponse.ProtoReflect.Descriptor instead.

func (*RunProbeResponse) GetResults added in v0.14.2 

func (x *RunProbeResponse) GetResults() map[string]*ProbeResults

func (*RunProbeResponse) ProtoMessage added in v0.14.2 

func (*RunProbeResponse) ProtoMessage()

func (*RunProbeResponse) ProtoReflect added in v0.14.2 

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

func (*RunProbeResponse) Reset added in v0.14.2 

func (x *RunProbeResponse) Reset()

func (*RunProbeResponse) String added in v0.14.2 

func (x *RunProbeResponse) String() string

type SaveProbesConfigRequest added in v0.13.3 

type SaveProbesConfigRequest struct {

	// File path to save probes config to. Default is configured through the
	// command-line flag: --probes_config_save_path
	FilePath *string `protobuf:"bytes,1,opt,name=file_path,json=filePath" json:"file_path,omitempty"`
	// contains filtered or unexported fields
}

func (*SaveProbesConfigRequest) Descriptor deprecated added in v0.13.3 

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

Deprecated: Use SaveProbesConfigRequest.ProtoReflect.Descriptor instead.

func (*SaveProbesConfigRequest) GetFilePath added in v0.13.3 

func (x *SaveProbesConfigRequest) GetFilePath() string

func (*SaveProbesConfigRequest) ProtoMessage added in v0.13.3 

func (*SaveProbesConfigRequest) ProtoMessage()

func (*SaveProbesConfigRequest) ProtoReflect added in v0.13.3 

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

func (*SaveProbesConfigRequest) Reset added in v0.13.3 

func (x *SaveProbesConfigRequest) Reset()

func (*SaveProbesConfigRequest) String added in v0.13.3 

func (x *SaveProbesConfigRequest) String() string

type SaveProbesConfigResponse added in v0.13.3 

type SaveProbesConfigResponse struct {
	FilePath *string `protobuf:"bytes,1,opt,name=file_path,json=filePath" json:"file_path,omitempty"`
	// contains filtered or unexported fields
}

func (*SaveProbesConfigResponse) Descriptor deprecated added in v0.13.3 

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

Deprecated: Use SaveProbesConfigResponse.ProtoReflect.Descriptor instead.

func (*SaveProbesConfigResponse) GetFilePath added in v0.13.3 

func (x *SaveProbesConfigResponse) GetFilePath() string

func (*SaveProbesConfigResponse) ProtoMessage added in v0.13.3 

func (*SaveProbesConfigResponse) ProtoMessage()

func (*SaveProbesConfigResponse) ProtoReflect added in v0.13.3 

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

func (*SaveProbesConfigResponse) Reset added in v0.13.3 

func (x *SaveProbesConfigResponse) Reset()

func (*SaveProbesConfigResponse) String added in v0.13.3 

func (x *SaveProbesConfigResponse) String() string

type UnimplementedCloudproberServer added in v0.10.4 

type UnimplementedCloudproberServer struct{}

UnimplementedCloudproberServer 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 (UnimplementedCloudproberServer) AddProbe added in v0.10.4 

func (UnimplementedCloudproberServer) AddProbe(context.Context, *AddProbeRequest) (*AddProbeResponse, error)

func (UnimplementedCloudproberServer) ListProbes added in v0.10.4 

func (UnimplementedCloudproberServer) ListProbes(context.Context, *ListProbesRequest) (*ListProbesResponse, error)

func (UnimplementedCloudproberServer) RemoveProbe added in v0.10.4 

func (UnimplementedCloudproberServer) RemoveProbe(context.Context, *RemoveProbeRequest) (*RemoveProbeResponse, error)

func (UnimplementedCloudproberServer) RunProbe added in v0.14.2 

func (UnimplementedCloudproberServer) RunProbe(context.Context, *RunProbeRequest) (*RunProbeResponse, error)

func (UnimplementedCloudproberServer) SaveProbesConfig added in v0.13.3 

func (UnimplementedCloudproberServer) SaveProbesConfig(context.Context, *SaveProbesConfigRequest) (*SaveProbesConfigResponse, error)

type UnsafeCloudproberServer added in v0.11.4 

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

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

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