protopb

package
v0.3.0-20260708152012-... Latest Latest
Warning

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

Go to latest
Published: Jul 8, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SubmitQueueGateway_Ping_FullMethodName   = "/uber.submitqueue.gateway.SubmitQueueGateway/Ping"
	SubmitQueueGateway_Land_FullMethodName   = "/uber.submitqueue.gateway.SubmitQueueGateway/Land"
	SubmitQueueGateway_Cancel_FullMethodName = "/uber.submitqueue.gateway.SubmitQueueGateway/Cancel"
	SubmitQueueGateway_Status_FullMethodName = "/uber.submitqueue.gateway.SubmitQueueGateway/Status"
)

Variables

View Source
var File_gateway_proto protoreflect.FileDescriptor
View Source
var SubmitQueueGateway_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "uber.submitqueue.gateway.SubmitQueueGateway",
	HandlerType: (*SubmitQueueGatewayServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Ping",
			Handler:    _SubmitQueueGateway_Ping_Handler,
		},
		{
			MethodName: "Land",
			Handler:    _SubmitQueueGateway_Land_Handler,
		},
		{
			MethodName: "Cancel",
			Handler:    _SubmitQueueGateway_Cancel_Handler,
		},
		{
			MethodName: "Status",
			Handler:    _SubmitQueueGateway_Status_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "gateway.proto",
}

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

Functions

func BuildSubmitQueueGatewayYARPCProcedures

func BuildSubmitQueueGatewayYARPCProcedures(server SubmitQueueGatewayYARPCServer) []transport.Procedure

BuildSubmitQueueGatewayYARPCProcedures prepares an implementation of the SubmitQueueGateway service for YARPC registration.

func NewFxSubmitQueueGatewayYARPCClient

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

NewFxSubmitQueueGatewayYARPCClient provides a SubmitQueueGatewayYARPCClient to an Fx application using the given name for routing.

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

func NewFxSubmitQueueGatewayYARPCProcedures

func NewFxSubmitQueueGatewayYARPCProcedures() interface{}

NewFxSubmitQueueGatewayYARPCProcedures provides SubmitQueueGatewayYARPCServer procedures to an Fx application. It expects a SubmitQueueGatewayYARPCServer to be present in the container.

fx.Provide(
  protopb.NewFxSubmitQueueGatewayYARPCProcedures(),
  ...
)

func RegisterSubmitQueueGatewayServer

func RegisterSubmitQueueGatewayServer(s grpc.ServiceRegistrar, srv SubmitQueueGatewayServer)

Types

type CancelRequest

type CancelRequest struct {

	// Globally unique identifier of the land request to cancel, returned by a prior Land call.
	Sqid string `protobuf:"bytes,1,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// Optional human-readable reason for the cancellation. Recorded for observability.
	Reason string `protobuf:"bytes,2,opt,name=reason,proto3" json:"reason,omitempty"`
	// contains filtered or unexported fields
}

CancelRequest defines a request to cancel an in-flight land request. If the request is part of a batch, the entire batch is cancelled.

func (*CancelRequest) Descriptor deprecated

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

Deprecated: Use CancelRequest.ProtoReflect.Descriptor instead.

func (*CancelRequest) GetReason

func (x *CancelRequest) GetReason() string

func (*CancelRequest) GetSqid

func (x *CancelRequest) GetSqid() string

func (*CancelRequest) ProtoMessage

func (*CancelRequest) ProtoMessage()

func (*CancelRequest) ProtoReflect

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

func (*CancelRequest) Reset

func (x *CancelRequest) Reset()

func (*CancelRequest) String

func (x *CancelRequest) String() string

type CancelResponse

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

CancelResponse defines the response to a cancel request. Empty on success.

A successful response indicates only that the cancellation intent was accepted and enqueued — it does NOT confirm that the request was actually cancelled. The terminal outcome may still be "landed" or "error" if a race was lost. Errors are returned as standard status codes (e.g. InvalidArgument for an empty sqid).

func (*CancelResponse) Descriptor deprecated

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

Deprecated: Use CancelResponse.ProtoReflect.Descriptor instead.

func (*CancelResponse) ProtoMessage

func (*CancelResponse) ProtoMessage()

func (*CancelResponse) ProtoReflect

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

func (*CancelResponse) Reset

func (x *CancelResponse) Reset()

func (*CancelResponse) String

func (x *CancelResponse) String() string

type Error

type Error struct {

	// Free text error message describing the error.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

Generic error with metadata. Each custom error type should extend this message.

func (*Error) Descriptor deprecated

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

Deprecated: Use Error.ProtoReflect.Descriptor instead.

func (*Error) GetMessage

func (x *Error) GetMessage() string

func (*Error) ProtoMessage

func (*Error) ProtoMessage()

func (*Error) ProtoReflect

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

func (*Error) Reset

func (x *Error) Reset()

func (*Error) String

func (x *Error) String() string

type FxSubmitQueueGatewayYARPCClientParams

type FxSubmitQueueGatewayYARPCClientParams struct {
	fx.In

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

FxSubmitQueueGatewayYARPCClientParams defines the input for NewFxSubmitQueueGatewayYARPCClient. It provides the paramaters to get a SubmitQueueGatewayYARPCClient in an Fx application.

type FxSubmitQueueGatewayYARPCClientResult

type FxSubmitQueueGatewayYARPCClientResult struct {
	fx.Out

	Client SubmitQueueGatewayYARPCClient
}

FxSubmitQueueGatewayYARPCClientResult defines the output of NewFxSubmitQueueGatewayYARPCClient. It provides a SubmitQueueGatewayYARPCClient to an Fx application.

type FxSubmitQueueGatewayYARPCProceduresParams

type FxSubmitQueueGatewayYARPCProceduresParams struct {
	fx.In

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

FxSubmitQueueGatewayYARPCProceduresParams defines the input for NewFxSubmitQueueGatewayYARPCProcedures. It provides the paramaters to get SubmitQueueGatewayYARPCServer procedures in an Fx application.

type FxSubmitQueueGatewayYARPCProceduresResult

type FxSubmitQueueGatewayYARPCProceduresResult struct {
	fx.Out

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

FxSubmitQueueGatewayYARPCProceduresResult defines the output of NewFxSubmitQueueGatewayYARPCProcedures. It provides SubmitQueueGatewayYARPCServer 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 LandRequest

type LandRequest struct {

	// Name of the queue processing the land request. The queue should be defined in the configuration, otherwise an error is returned.
	Queue string `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// Change (such as a pull request) to land into the target branch. Target branch is defined by the queue configuration.
	Change *protopb.Change `protobuf:"bytes,2,opt,name=change,proto3" json:"change,omitempty"`
	// Source control integration strategy to use for this land operation. If not specified, the default queue strategy is used.
	Strategy protopb1.Strategy `protobuf:"varint,4,opt,name=strategy,proto3,enum=uber.base.mergestrategy.Strategy" json:"strategy,omitempty"`
	// contains filtered or unexported fields
}

LandRequest defines a request to land (merge into target branch of the source control repository) a set of code changes.

SubmitQueue guarantees changes are landed in order with no other changes in between. SubmitQueue does not guarantee each change is individually valid, but produces a validity marker on such changes. The user is responsible for including all changes in a stack in order, starting from the earliest change.

func (*LandRequest) Descriptor deprecated

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

Deprecated: Use LandRequest.ProtoReflect.Descriptor instead.

func (*LandRequest) GetChange

func (x *LandRequest) GetChange() *protopb.Change

func (*LandRequest) GetQueue

func (x *LandRequest) GetQueue() string

func (*LandRequest) GetStrategy

func (x *LandRequest) GetStrategy() protopb1.Strategy

func (*LandRequest) ProtoMessage

func (*LandRequest) ProtoMessage()

func (*LandRequest) ProtoReflect

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

func (*LandRequest) Reset

func (x *LandRequest) Reset()

func (*LandRequest) String

func (x *LandRequest) String() string

type LandResponse

type LandResponse struct {

	// Globally unique identifier for the land request. Used to track the land request lifecycle.
	Sqid string `protobuf:"bytes,1,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// contains filtered or unexported fields
}

LandResponse defines the response to a land request.

func (*LandResponse) Descriptor deprecated

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

Deprecated: Use LandResponse.ProtoReflect.Descriptor instead.

func (*LandResponse) GetSqid

func (x *LandResponse) GetSqid() string

func (*LandResponse) ProtoMessage

func (*LandResponse) ProtoMessage()

func (*LandResponse) ProtoReflect

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

func (*LandResponse) Reset

func (x *LandResponse) Reset()

func (*LandResponse) String

func (x *LandResponse) String() string

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 RequestNotFoundError

type RequestNotFoundError struct {

	// Free text error message describing the error.
	Error *Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// The sqid that was not found.
	Sqid string `protobuf:"bytes,2,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// contains filtered or unexported fields
}

RequestNotFoundError is returned when no request is found for the given sqid. Typically this indicates a typo in the sqid or that the request has not been accepted yet.

func (*RequestNotFoundError) Descriptor deprecated

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

Deprecated: Use RequestNotFoundError.ProtoReflect.Descriptor instead.

func (*RequestNotFoundError) GetError

func (x *RequestNotFoundError) GetError() *Error

func (*RequestNotFoundError) GetSqid

func (x *RequestNotFoundError) GetSqid() string

func (*RequestNotFoundError) ProtoMessage

func (*RequestNotFoundError) ProtoMessage()

func (*RequestNotFoundError) ProtoReflect

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

func (*RequestNotFoundError) Reset

func (x *RequestNotFoundError) Reset()

func (*RequestNotFoundError) String

func (x *RequestNotFoundError) String() string

type StatusRequest

type StatusRequest struct {

	// Globally unique identifier for the request, as returned by Land in the LandResponse.
	Sqid string `protobuf:"bytes,1,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// contains filtered or unexported fields
}

StatusRequest defines a request to look up the current status of a previously submitted request.

func (*StatusRequest) Descriptor deprecated

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

Deprecated: Use StatusRequest.ProtoReflect.Descriptor instead.

func (*StatusRequest) GetSqid

func (x *StatusRequest) GetSqid() string

func (*StatusRequest) ProtoMessage

func (*StatusRequest) ProtoMessage()

func (*StatusRequest) ProtoReflect

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

func (*StatusRequest) Reset

func (x *StatusRequest) Reset()

func (*StatusRequest) String

func (x *StatusRequest) String() string

type StatusResponse

type StatusResponse struct {

	// Current customer-friendly status of the request (e.g. "accepted", "validating", "landed", "error").
	// Status is a free-form string because the system may introduce new statuses without breaking existing clients.
	Status string `protobuf:"bytes,1,opt,name=status,proto3" json:"status,omitempty"`
	// Last error message associated with the current status. Empty string if there is no error.
	LastError string `protobuf:"bytes,2,opt,name=last_error,json=lastError,proto3" json:"last_error,omitempty"`
	// Free-form key-value metadata associated with the current status, for display or debugging purposes. Empty if none.
	Metadata map[string]string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

StatusResponse defines the response to a status request. The status is eventually consistent with the request store; it might take some time to converge, typically no more than a few seconds.

func (*StatusResponse) Descriptor deprecated

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

Deprecated: Use StatusResponse.ProtoReflect.Descriptor instead.

func (*StatusResponse) GetLastError

func (x *StatusResponse) GetLastError() string

func (*StatusResponse) GetMetadata

func (x *StatusResponse) GetMetadata() map[string]string

func (*StatusResponse) GetStatus

func (x *StatusResponse) GetStatus() string

func (*StatusResponse) ProtoMessage

func (*StatusResponse) ProtoMessage()

func (*StatusResponse) ProtoReflect

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

func (*StatusResponse) Reset

func (x *StatusResponse) Reset()

func (*StatusResponse) String

func (x *StatusResponse) String() string

type SubmitQueueGatewayClient

type SubmitQueueGatewayClient interface {
	// Ping returns a response indicating the service is alive
	Ping(ctx context.Context, in *PingRequest, opts ...grpc.CallOption) (*PingResponse, error)
	// Land lands a set of code changes into a target branch, performing the necessary validations across all other changes in the queue.
	// The processing is asynchronous and returns a LandResponse immediately. The land request is processed in the background.
	Land(ctx context.Context, in *LandRequest, opts ...grpc.CallOption) (*LandResponse, error)
	// Cancel cancels an in-flight land request identified by its sqid. If the request has already been included in a batch,
	// the entire batch is cancelled. Cancel is idempotent — calling it for an already-terminal request is a no-op.
	//
	// Cancellation is ASYNCHRONOUS: Cancel returns as soon as the cancellation intent has been accepted; the actual
	// state transition is performed in the background by the orchestrator and may not have completed by the time the
	// caller receives a response.
	//
	// Cancellation is NOT GUARANTEED: a request that has already merged, or that races to completion before the cancel
	// signal propagates through the pipeline, may still land (or end in an error). Callers must NOT assume that a
	// successful Cancel response means the request was cancelled — the actual terminal outcome (cancelled, landed, or
	// error) must be checked through the separate status / request-log API.
	Cancel(ctx context.Context, in *CancelRequest, opts ...grpc.CallOption) (*CancelResponse, error)
	// Status returns the current status of a previously submitted request, identified by its sqid.
	// The status is eventually consistent with the request store and reconciled from the append-only request log.
	Status(ctx context.Context, in *StatusRequest, opts ...grpc.CallOption) (*StatusResponse, error)
}

SubmitQueueGatewayClient is the client API for SubmitQueueGateway 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.

SubmitQueueGateway provides the gateway API

type SubmitQueueGatewayServer

type SubmitQueueGatewayServer interface {
	// Ping returns a response indicating the service is alive
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	// Land lands a set of code changes into a target branch, performing the necessary validations across all other changes in the queue.
	// The processing is asynchronous and returns a LandResponse immediately. The land request is processed in the background.
	Land(context.Context, *LandRequest) (*LandResponse, error)
	// Cancel cancels an in-flight land request identified by its sqid. If the request has already been included in a batch,
	// the entire batch is cancelled. Cancel is idempotent — calling it for an already-terminal request is a no-op.
	//
	// Cancellation is ASYNCHRONOUS: Cancel returns as soon as the cancellation intent has been accepted; the actual
	// state transition is performed in the background by the orchestrator and may not have completed by the time the
	// caller receives a response.
	//
	// Cancellation is NOT GUARANTEED: a request that has already merged, or that races to completion before the cancel
	// signal propagates through the pipeline, may still land (or end in an error). Callers must NOT assume that a
	// successful Cancel response means the request was cancelled — the actual terminal outcome (cancelled, landed, or
	// error) must be checked through the separate status / request-log API.
	Cancel(context.Context, *CancelRequest) (*CancelResponse, error)
	// Status returns the current status of a previously submitted request, identified by its sqid.
	// The status is eventually consistent with the request store and reconciled from the append-only request log.
	Status(context.Context, *StatusRequest) (*StatusResponse, error)
	// contains filtered or unexported methods
}

SubmitQueueGatewayServer is the server API for SubmitQueueGateway service. All implementations must embed UnimplementedSubmitQueueGatewayServer for forward compatibility.

SubmitQueueGateway provides the gateway API

type SubmitQueueGatewayYARPCClient

SubmitQueueGatewayYARPCClient is the YARPC client-side interface for the SubmitQueueGateway service.

func NewSubmitQueueGatewayYARPCClient

func NewSubmitQueueGatewayYARPCClient(clientConfig transport.ClientConfig, options ...v2.ClientOption) SubmitQueueGatewayYARPCClient

NewSubmitQueueGatewayYARPCClient builds a new YARPC client for the SubmitQueueGateway service.

type SubmitQueueGatewayYARPCServer

type SubmitQueueGatewayYARPCServer interface {
	Ping(context.Context, *PingRequest) (*PingResponse, error)
	Land(context.Context, *LandRequest) (*LandResponse, error)
	Cancel(context.Context, *CancelRequest) (*CancelResponse, error)
	Status(context.Context, *StatusRequest) (*StatusResponse, error)
}

SubmitQueueGatewayYARPCServer is the YARPC server-side interface for the SubmitQueueGateway service.

type UnimplementedSubmitQueueGatewayServer

type UnimplementedSubmitQueueGatewayServer struct{}

UnimplementedSubmitQueueGatewayServer 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 (UnimplementedSubmitQueueGatewayServer) Cancel

func (UnimplementedSubmitQueueGatewayServer) Land

func (UnimplementedSubmitQueueGatewayServer) Ping

func (UnimplementedSubmitQueueGatewayServer) Status

type UnrecognizedQueueError

type UnrecognizedQueueError struct {

	// Free text error message describing the error.
	Error *Error `protobuf:"bytes,1,opt,name=error,proto3" json:"error,omitempty"`
	// Name of the queue that was not recognized.
	Queue string `protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
	// contains filtered or unexported fields
}

UnrecognizedQueueError is returned when a queue name is not recognized. Typically this indicates a typo in the queue name or server misconfiguration.

func (*UnrecognizedQueueError) Descriptor deprecated

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

Deprecated: Use UnrecognizedQueueError.ProtoReflect.Descriptor instead.

func (*UnrecognizedQueueError) GetError

func (x *UnrecognizedQueueError) GetError() *Error

func (*UnrecognizedQueueError) GetQueue

func (x *UnrecognizedQueueError) GetQueue() string

func (*UnrecognizedQueueError) ProtoMessage

func (*UnrecognizedQueueError) ProtoMessage()

func (*UnrecognizedQueueError) ProtoReflect

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

func (*UnrecognizedQueueError) Reset

func (x *UnrecognizedQueueError) Reset()

func (*UnrecognizedQueueError) String

func (x *UnrecognizedQueueError) String() string

type UnsafeSubmitQueueGatewayServer

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

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

Jump to

Keyboard shortcuts

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