protopb

package
v0.1.0-dev9 Latest Latest
Warning

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

Go to latest
Published: Jun 16, 2026 License: Apache-2.0 Imports: 17 Imported by: 0

Documentation

Index

Constants

View Source
const (
	StovepipeOrchestrator_Ping_FullMethodName = "/uber.submitqueue.stovepipe.orchestrator.StovepipeOrchestrator/Ping"
)

Variables

View Source
var File_orchestrator_proto protoreflect.FileDescriptor
View Source
var StovepipeOrchestrator_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "uber.submitqueue.stovepipe.orchestrator.StovepipeOrchestrator",
	HandlerType: (*StovepipeOrchestratorServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Ping",
			Handler:    _StovepipeOrchestrator_Ping_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "orchestrator.proto",
}

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

Functions

func BuildStovepipeOrchestratorYARPCProcedures

func BuildStovepipeOrchestratorYARPCProcedures(server StovepipeOrchestratorYARPCServer) []transport.Procedure

BuildStovepipeOrchestratorYARPCProcedures prepares an implementation of the StovepipeOrchestrator service for YARPC registration.

func NewFxStovepipeOrchestratorYARPCClient

func NewFxStovepipeOrchestratorYARPCClient(name string, options ...v2.ClientOption) interface{}

NewFxStovepipeOrchestratorYARPCClient provides a StovepipeOrchestratorYARPCClient to an Fx application using the given name for routing.

fx.Provide(
  protopb.NewFxStovepipeOrchestratorYARPCClient("service-name"),
  ...
)

func NewFxStovepipeOrchestratorYARPCProcedures

func NewFxStovepipeOrchestratorYARPCProcedures() interface{}

NewFxStovepipeOrchestratorYARPCProcedures provides StovepipeOrchestratorYARPCServer procedures to an Fx application. It expects a StovepipeOrchestratorYARPCServer to be present in the container.

fx.Provide(
  protopb.NewFxStovepipeOrchestratorYARPCProcedures(),
  ...
)

func RegisterStovepipeOrchestratorServer

func RegisterStovepipeOrchestratorServer(s grpc.ServiceRegistrar, srv StovepipeOrchestratorServer)

Types

type FxStovepipeOrchestratorYARPCClientParams

type FxStovepipeOrchestratorYARPCClientParams struct {
	fx.In

	Provider    yarpc.ClientConfig
	AnyResolver v2.AnyResolver      `name:"yarpcfx" optional:"true"`
	Restriction restriction.Checker `optional:"true"`
}

FxStovepipeOrchestratorYARPCClientParams defines the input for NewFxStovepipeOrchestratorYARPCClient. It provides the paramaters to get a StovepipeOrchestratorYARPCClient in an Fx application.

type FxStovepipeOrchestratorYARPCClientResult

type FxStovepipeOrchestratorYARPCClientResult struct {
	fx.Out

	Client StovepipeOrchestratorYARPCClient
}

FxStovepipeOrchestratorYARPCClientResult defines the output of NewFxStovepipeOrchestratorYARPCClient. It provides a StovepipeOrchestratorYARPCClient to an Fx application.

type FxStovepipeOrchestratorYARPCProceduresParams

type FxStovepipeOrchestratorYARPCProceduresParams struct {
	fx.In

	Server      StovepipeOrchestratorYARPCServer
	AnyResolver v2.AnyResolver `name:"yarpcfx" optional:"true"`
}

FxStovepipeOrchestratorYARPCProceduresParams defines the input for NewFxStovepipeOrchestratorYARPCProcedures. It provides the paramaters to get StovepipeOrchestratorYARPCServer procedures in an Fx application.

type FxStovepipeOrchestratorYARPCProceduresResult

type FxStovepipeOrchestratorYARPCProceduresResult struct {
	fx.Out

	Procedures     []transport.Procedure `group:"yarpcfx"`
	ReflectionMeta reflection.ServerMeta `group:"yarpcfx"`
}

FxStovepipeOrchestratorYARPCProceduresResult defines the output of NewFxStovepipeOrchestratorYARPCProcedures. It provides StovepipeOrchestratorYARPCServer procedures to an Fx application.

The procedures are provided to the "yarpcfx" value group. Dig 1.2 or newer must be used for this feature to work.

type PingRequest

type PingRequest struct {

	// Optional message to include in the ping
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

PingRequest is the request for the Ping method

func (*PingRequest) Descriptor deprecated

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

Deprecated: Use PingRequest.ProtoReflect.Descriptor instead.

func (*PingRequest) GetMessage

func (x *PingRequest) GetMessage() string

func (*PingRequest) ProtoMessage

func (*PingRequest) ProtoMessage()

func (*PingRequest) ProtoReflect

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

func (*PingRequest) Reset

func (x *PingRequest) Reset()

func (*PingRequest) String

func (x *PingRequest) String() string

type PingResponse

type PingResponse struct {

	// The response message
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// The service name that handled the request
	ServiceName string `protobuf:"bytes,2,opt,name=service_name,json=serviceName,proto3" json:"service_name,omitempty"`
	// Timestamp of when the ping was received
	Timestamp int64 `protobuf:"varint,3,opt,name=timestamp,proto3" json:"timestamp,omitempty"`
	// Hostname of the server that handled the request
	Hostname string `protobuf:"bytes,4,opt,name=hostname,proto3" json:"hostname,omitempty"`
	// contains filtered or unexported fields
}

PingResponse is the response for the Ping method

func (*PingResponse) Descriptor deprecated

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

Deprecated: Use PingResponse.ProtoReflect.Descriptor instead.

func (*PingResponse) GetHostname

func (x *PingResponse) GetHostname() string

func (*PingResponse) GetMessage

func (x *PingResponse) GetMessage() string

func (*PingResponse) GetServiceName

func (x *PingResponse) GetServiceName() string

func (*PingResponse) GetTimestamp

func (x *PingResponse) GetTimestamp() int64

func (*PingResponse) ProtoMessage

func (*PingResponse) ProtoMessage()

func (*PingResponse) ProtoReflect

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

func (*PingResponse) Reset

func (x *PingResponse) Reset()

func (*PingResponse) String

func (x *PingResponse) String() string

type StovepipeOrchestratorClient

type StovepipeOrchestratorClient interface {
	// Ping returns a response indicating the service is alive
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
}

StovepipeOrchestratorClient is the client API for StovepipeOrchestrator 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.

StovepipeOrchestrator provides the Stovepipe orchestrator API.

type StovepipeOrchestratorServer

type StovepipeOrchestratorServer interface {
	// Ping returns a response indicating the service is alive
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	// contains filtered or unexported methods
}

StovepipeOrchestratorServer is the server API for StovepipeOrchestrator service. All implementations must embed UnimplementedStovepipeOrchestratorServer for forward compatibility.

StovepipeOrchestrator provides the Stovepipe orchestrator API.

type StovepipeOrchestratorYARPCClient

type StovepipeOrchestratorYARPCClient interface {
	Ping(context.Context, *PingRequest, ...yarpc.CallOption) (*PingResponse, error)
}

StovepipeOrchestratorYARPCClient is the YARPC client-side interface for the StovepipeOrchestrator service.

func NewStovepipeOrchestratorYARPCClient

func NewStovepipeOrchestratorYARPCClient(clientConfig transport.ClientConfig, options ...v2.ClientOption) StovepipeOrchestratorYARPCClient

NewStovepipeOrchestratorYARPCClient builds a new YARPC client for the StovepipeOrchestrator service.

type StovepipeOrchestratorYARPCServer

type StovepipeOrchestratorYARPCServer interface {
	Ping(context.Context, *PingRequest) (*PingResponse, error)
}

StovepipeOrchestratorYARPCServer is the YARPC server-side interface for the StovepipeOrchestrator service.

type UnimplementedStovepipeOrchestratorServer

type UnimplementedStovepipeOrchestratorServer struct{}

UnimplementedStovepipeOrchestratorServer 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 (UnimplementedStovepipeOrchestratorServer) Ping

type UnsafeStovepipeOrchestratorServer

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

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

Jump to

Keyboard shortcuts

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