protopb

package
v0.3.0-20260730213620-... Latest Latest
Warning

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

Go to latest
Published: Jul 30, 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_GetRequestSummaryByID_FullMethodName        = "/uber.submitqueue.gateway.SubmitQueueGateway/GetRequestSummaryByID"
	SubmitQueueGateway_GetRequestSummaryByChangeURI_FullMethodName = "/uber.submitqueue.gateway.SubmitQueueGateway/GetRequestSummaryByChangeURI"
	SubmitQueueGateway_List_FullMethodName                         = "/uber.submitqueue.gateway.SubmitQueueGateway/List"
	SubmitQueueGateway_GetRequestHistoryByID_FullMethodName        = "/uber.submitqueue.gateway.SubmitQueueGateway/GetRequestHistoryByID"
	SubmitQueueGateway_GetRequestHistoryByChangeURI_FullMethodName = "/uber.submitqueue.gateway.SubmitQueueGateway/GetRequestHistoryByChangeURI"
)

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: "GetRequestSummaryByID",
			Handler:    _SubmitQueueGateway_GetRequestSummaryByID_Handler,
		},
		{
			MethodName: "GetRequestSummaryByChangeURI",
			Handler:    _SubmitQueueGateway_GetRequestSummaryByChangeURI_Handler,
		},
		{
			MethodName: "List",
			Handler:    _SubmitQueueGateway_List_Handler,
		},
		{
			MethodName: "GetRequestHistoryByID",
			Handler:    _SubmitQueueGateway_GetRequestHistoryByID_Handler,
		},
		{
			MethodName: "GetRequestHistoryByChangeURI",
			Handler:    _SubmitQueueGateway_GetRequestHistoryByChangeURI_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 GetRequestHistoryByChangeURIRequest

type GetRequestHistoryByChangeURIRequest struct {

	// Exact change URI supplied in a Land request.
	ChangeUri string `protobuf:"bytes,1,opt,name=change_uri,json=changeUri,proto3" json:"change_uri,omitempty"`
	// contains filtered or unexported fields
}

GetRequestHistoryByChangeURIRequest selects retained histories by an exact pinned change URI.

func (*GetRequestHistoryByChangeURIRequest) Descriptor deprecated

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

Deprecated: Use GetRequestHistoryByChangeURIRequest.ProtoReflect.Descriptor instead.

func (*GetRequestHistoryByChangeURIRequest) GetChangeUri

func (x *GetRequestHistoryByChangeURIRequest) GetChangeUri() string

func (*GetRequestHistoryByChangeURIRequest) ProtoMessage

func (*GetRequestHistoryByChangeURIRequest) ProtoMessage()

func (*GetRequestHistoryByChangeURIRequest) ProtoReflect

func (*GetRequestHistoryByChangeURIRequest) Reset

func (*GetRequestHistoryByChangeURIRequest) String

type GetRequestHistoryByChangeURIResponse

type GetRequestHistoryByChangeURIResponse struct {

	// Matching request histories.
	Histories []*RequestHistory `protobuf:"bytes,1,rep,name=histories,proto3" json:"histories,omitempty"`
	// contains filtered or unexported fields
}

GetRequestHistoryByChangeURIResponse contains retained histories ordered by numeric sqid counter ascending.

func (*GetRequestHistoryByChangeURIResponse) Descriptor deprecated

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

Deprecated: Use GetRequestHistoryByChangeURIResponse.ProtoReflect.Descriptor instead.

func (*GetRequestHistoryByChangeURIResponse) GetHistories

func (*GetRequestHistoryByChangeURIResponse) ProtoMessage

func (*GetRequestHistoryByChangeURIResponse) ProtoMessage()

func (*GetRequestHistoryByChangeURIResponse) ProtoReflect

func (*GetRequestHistoryByChangeURIResponse) Reset

func (*GetRequestHistoryByChangeURIResponse) String

type GetRequestHistoryByIDRequest

type GetRequestHistoryByIDRequest struct {

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

GetRequestHistoryByIDRequest selects one retained request history by sqid.

func (*GetRequestHistoryByIDRequest) Descriptor deprecated

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

Deprecated: Use GetRequestHistoryByIDRequest.ProtoReflect.Descriptor instead.

func (*GetRequestHistoryByIDRequest) GetSqid

func (x *GetRequestHistoryByIDRequest) GetSqid() string

func (*GetRequestHistoryByIDRequest) ProtoMessage

func (*GetRequestHistoryByIDRequest) ProtoMessage()

func (*GetRequestHistoryByIDRequest) ProtoReflect

func (*GetRequestHistoryByIDRequest) Reset

func (x *GetRequestHistoryByIDRequest) Reset()

func (*GetRequestHistoryByIDRequest) String

type GetRequestHistoryByIDResponse

type GetRequestHistoryByIDResponse struct {

	// Events ordered by timestamp ascending with a stable storage tie-breaker.
	Events []*HistoryEvent `protobuf:"bytes,1,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

GetRequestHistoryByIDResponse contains all retained events for one request.

func (*GetRequestHistoryByIDResponse) Descriptor deprecated

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

Deprecated: Use GetRequestHistoryByIDResponse.ProtoReflect.Descriptor instead.

func (*GetRequestHistoryByIDResponse) GetEvents

func (x *GetRequestHistoryByIDResponse) GetEvents() []*HistoryEvent

func (*GetRequestHistoryByIDResponse) ProtoMessage

func (*GetRequestHistoryByIDResponse) ProtoMessage()

func (*GetRequestHistoryByIDResponse) ProtoReflect

func (*GetRequestHistoryByIDResponse) Reset

func (x *GetRequestHistoryByIDResponse) Reset()

func (*GetRequestHistoryByIDResponse) String

type GetRequestSummaryByChangeURIRequest

type GetRequestSummaryByChangeURIRequest struct {

	// Exact change URI supplied in a Land request.
	ChangeUri string `protobuf:"bytes,1,opt,name=change_uri,json=changeUri,proto3" json:"change_uri,omitempty"`
	// contains filtered or unexported fields
}

GetRequestSummaryByChangeURIRequest selects requests by an exact pinned change URI.

func (*GetRequestSummaryByChangeURIRequest) Descriptor deprecated

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

Deprecated: Use GetRequestSummaryByChangeURIRequest.ProtoReflect.Descriptor instead.

func (*GetRequestSummaryByChangeURIRequest) GetChangeUri

func (x *GetRequestSummaryByChangeURIRequest) GetChangeUri() string

func (*GetRequestSummaryByChangeURIRequest) ProtoMessage

func (*GetRequestSummaryByChangeURIRequest) ProtoMessage()

func (*GetRequestSummaryByChangeURIRequest) ProtoReflect

func (*GetRequestSummaryByChangeURIRequest) Reset

func (*GetRequestSummaryByChangeURIRequest) String

type GetRequestSummaryByChangeURIResponse

type GetRequestSummaryByChangeURIResponse struct {

	// Matching requests ordered by receipt time descending, then sqid descending.
	Requests []*RequestSummary `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
	// contains filtered or unexported fields
}

GetRequestSummaryByChangeURIResponse contains matching requests newest first.

func (*GetRequestSummaryByChangeURIResponse) Descriptor deprecated

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

Deprecated: Use GetRequestSummaryByChangeURIResponse.ProtoReflect.Descriptor instead.

func (*GetRequestSummaryByChangeURIResponse) GetRequests

func (*GetRequestSummaryByChangeURIResponse) ProtoMessage

func (*GetRequestSummaryByChangeURIResponse) ProtoMessage()

func (*GetRequestSummaryByChangeURIResponse) ProtoReflect

func (*GetRequestSummaryByChangeURIResponse) Reset

func (*GetRequestSummaryByChangeURIResponse) String

type GetRequestSummaryByIDRequest

type GetRequestSummaryByIDRequest struct {

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

GetRequestSummaryByIDRequest selects one request by the sqid returned from Land.

func (*GetRequestSummaryByIDRequest) Descriptor deprecated

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

Deprecated: Use GetRequestSummaryByIDRequest.ProtoReflect.Descriptor instead.

func (*GetRequestSummaryByIDRequest) GetSqid

func (x *GetRequestSummaryByIDRequest) GetSqid() string

func (*GetRequestSummaryByIDRequest) ProtoMessage

func (*GetRequestSummaryByIDRequest) ProtoMessage()

func (*GetRequestSummaryByIDRequest) ProtoReflect

func (*GetRequestSummaryByIDRequest) Reset

func (x *GetRequestSummaryByIDRequest) Reset()

func (*GetRequestSummaryByIDRequest) String

type GetRequestSummaryByIDResponse

type GetRequestSummaryByIDResponse struct {

	// Matching request.
	Request *RequestSummary `protobuf:"bytes,1,opt,name=request,proto3" json:"request,omitempty"`
	// contains filtered or unexported fields
}

GetRequestSummaryByIDResponse contains the current materialized request view.

func (*GetRequestSummaryByIDResponse) Descriptor deprecated

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

Deprecated: Use GetRequestSummaryByIDResponse.ProtoReflect.Descriptor instead.

func (*GetRequestSummaryByIDResponse) GetRequest

func (*GetRequestSummaryByIDResponse) ProtoMessage

func (*GetRequestSummaryByIDResponse) ProtoMessage()

func (*GetRequestSummaryByIDResponse) ProtoReflect

func (*GetRequestSummaryByIDResponse) Reset

func (x *GetRequestSummaryByIDResponse) Reset()

func (*GetRequestSummaryByIDResponse) String

type HistoryEvent

type HistoryEvent struct {

	// Time the request-log entry was created, in Unix milliseconds.
	TimestampMs int64 `protobuf:"varint,1,opt,name=timestamp_ms,json=timestampMs,proto3" json:"timestamp_ms,omitempty"`
	// Customer-friendly request status recorded by the event.
	Status string `protobuf:"bytes,2,opt,name=status,proto3" json:"status,omitempty"`
	// Error message associated with the event. Empty when absent.
	LastError string `protobuf:"bytes,3,opt,name=last_error,json=lastError,proto3" json:"last_error,omitempty"`
	// Display and debugging metadata associated with this event. Each lifecycle event carries its own values.
	Metadata map[string]string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

HistoryEvent is one retained append-only request-log event.

func (*HistoryEvent) Descriptor deprecated

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

Deprecated: Use HistoryEvent.ProtoReflect.Descriptor instead.

func (*HistoryEvent) GetLastError

func (x *HistoryEvent) GetLastError() string

func (*HistoryEvent) GetMetadata

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

func (*HistoryEvent) GetStatus

func (x *HistoryEvent) GetStatus() string

func (*HistoryEvent) GetTimestampMs

func (x *HistoryEvent) GetTimestampMs() int64

func (*HistoryEvent) ProtoMessage

func (*HistoryEvent) ProtoMessage()

func (*HistoryEvent) ProtoReflect

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

func (*HistoryEvent) Reset

func (x *HistoryEvent) Reset()

func (*HistoryEvent) String

func (x *HistoryEvent) String() string

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 ListRequest

type ListRequest struct {

	// Exact queue to query.
	Queue string `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// Inclusive lower receipt-time bound in Unix milliseconds.
	ReceivedAtOrAfterMs int64 `protobuf:"varint,2,opt,name=received_at_or_after_ms,json=receivedAtOrAfterMs,proto3" json:"received_at_or_after_ms,omitempty"`
	// Exclusive upper receipt-time bound in Unix milliseconds.
	ReceivedBeforeMs int64 `protobuf:"varint,3,opt,name=received_before_ms,json=receivedBeforeMs,proto3" json:"received_before_ms,omitempty"`
	// Maximum results to return. Zero selects the server default; values above the server maximum are invalid.
	PageSize int32 `protobuf:"varint,4,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"`
	// Opaque continuation token from a previous response. Empty selects the first page.
	PageToken string `protobuf:"bytes,5,opt,name=page_token,json=pageToken,proto3" json:"page_token,omitempty"`
	// contains filtered or unexported fields
}

ListRequest defines one bounded queue receipt-history query.

func (*ListRequest) Descriptor deprecated

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

Deprecated: Use ListRequest.ProtoReflect.Descriptor instead.

func (*ListRequest) GetPageSize

func (x *ListRequest) GetPageSize() int32

func (*ListRequest) GetPageToken

func (x *ListRequest) GetPageToken() string

func (*ListRequest) GetQueue

func (x *ListRequest) GetQueue() string

func (*ListRequest) GetReceivedAtOrAfterMs

func (x *ListRequest) GetReceivedAtOrAfterMs() int64

func (*ListRequest) GetReceivedBeforeMs

func (x *ListRequest) GetReceivedBeforeMs() int64

func (*ListRequest) ProtoMessage

func (*ListRequest) ProtoMessage()

func (*ListRequest) ProtoReflect

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

func (*ListRequest) Reset

func (x *ListRequest) Reset()

func (*ListRequest) String

func (x *ListRequest) String() string

type ListResponse

type ListResponse struct {

	// Requests ordered by receipt time descending, then sqid descending.
	Requests []*RequestSummary `protobuf:"bytes,1,rep,name=requests,proto3" json:"requests,omitempty"`
	// Opaque continuation token. Empty when this is the last page.
	NextPageToken string `protobuf:"bytes,2,opt,name=next_page_token,json=nextPageToken,proto3" json:"next_page_token,omitempty"`
	// contains filtered or unexported fields
}

ListResponse defines one page of queue receipt history.

func (*ListResponse) Descriptor deprecated

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

Deprecated: Use ListResponse.ProtoReflect.Descriptor instead.

func (*ListResponse) GetNextPageToken

func (x *ListResponse) GetNextPageToken() string

func (*ListResponse) GetRequests

func (x *ListResponse) GetRequests() []*RequestSummary

func (*ListResponse) ProtoMessage

func (*ListResponse) ProtoMessage()

func (*ListResponse) ProtoReflect

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

func (*ListResponse) Reset

func (x *ListResponse) Reset()

func (*ListResponse) String

func (x *ListResponse) 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 RequestHistory

type RequestHistory struct {

	// Globally unique request identifier.
	Sqid string `protobuf:"bytes,1,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// Retained events ordered chronologically.
	Events []*HistoryEvent `protobuf:"bytes,2,rep,name=events,proto3" json:"events,omitempty"`
	// contains filtered or unexported fields
}

RequestHistory groups retained events for one request.

func (*RequestHistory) Descriptor deprecated

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

Deprecated: Use RequestHistory.ProtoReflect.Descriptor instead.

func (*RequestHistory) GetEvents

func (x *RequestHistory) GetEvents() []*HistoryEvent

func (*RequestHistory) GetSqid

func (x *RequestHistory) GetSqid() string

func (*RequestHistory) ProtoMessage

func (*RequestHistory) ProtoMessage()

func (*RequestHistory) ProtoReflect

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

func (*RequestHistory) Reset

func (x *RequestHistory) Reset()

func (*RequestHistory) String

func (x *RequestHistory) 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"`
	// Exact change URI that was not found. Populated only for change-URI lookup.
	ChangeUri string `protobuf:"bytes,3,opt,name=change_uri,json=changeUri,proto3" json:"change_uri,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) GetChangeUri

func (x *RequestNotFoundError) GetChangeUri() string

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 RequestSummary

type RequestSummary struct {

	// Globally unique request identifier. This is request_id in internal storage.
	Sqid string `protobuf:"bytes,1,opt,name=sqid,proto3" json:"sqid,omitempty"`
	// Queue supplied when the request was received.
	Queue string `protobuf:"bytes,2,opt,name=queue,proto3" json:"queue,omitempty"`
	// Change URIs supplied when the request was received, in caller order.
	ChangeUris []string `protobuf:"bytes,3,rep,name=change_uris,json=changeUris,proto3" json:"change_uris,omitempty"`
	// Receipt time in Unix milliseconds.
	ReceivedAtMs int64 `protobuf:"varint,4,opt,name=received_at_ms,json=receivedAtMs,proto3" json:"received_at_ms,omitempty"`
	// Current customer-friendly status of the request.
	Status string `protobuf:"bytes,5,opt,name=status,proto3" json:"status,omitempty"`
	// Last error associated with the current status. Empty when absent.
	LastError string `protobuf:"bytes,6,opt,name=last_error,json=lastError,proto3" json:"last_error,omitempty"`
	// Display and debugging metadata associated with the current status.
	Metadata map[string]string `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

RequestSummary is the gateway-owned materialized current view of one received request.

func (*RequestSummary) Descriptor deprecated

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

Deprecated: Use RequestSummary.ProtoReflect.Descriptor instead.

func (*RequestSummary) GetChangeUris

func (x *RequestSummary) GetChangeUris() []string

func (*RequestSummary) GetLastError

func (x *RequestSummary) GetLastError() string

func (*RequestSummary) GetMetadata

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

func (*RequestSummary) GetQueue

func (x *RequestSummary) GetQueue() string

func (*RequestSummary) GetReceivedAtMs

func (x *RequestSummary) GetReceivedAtMs() int64

func (*RequestSummary) GetSqid

func (x *RequestSummary) GetSqid() string

func (*RequestSummary) GetStatus

func (x *RequestSummary) GetStatus() string

func (*RequestSummary) ProtoMessage

func (*RequestSummary) ProtoMessage()

func (*RequestSummary) ProtoReflect

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

func (*RequestSummary) Reset

func (x *RequestSummary) Reset()

func (*RequestSummary) String

func (x *RequestSummary) 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 request-summary or request-history APIs.
	Cancel(ctx context.Context, in *CancelRequest, opts ...grpc.CallOption) (*CancelResponse, error)
	// GetRequestSummaryByID returns the current materialized status of one request.
	GetRequestSummaryByID(ctx context.Context, in *GetRequestSummaryByIDRequest, opts ...grpc.CallOption) (*GetRequestSummaryByIDResponse, error)
	// GetRequestSummaryByChangeURI returns current materialized statuses for an exact pinned change URI.
	GetRequestSummaryByChangeURI(ctx context.Context, in *GetRequestSummaryByChangeURIRequest, opts ...grpc.CallOption) (*GetRequestSummaryByChangeURIResponse, error)
	// List returns requests received for one queue during a bounded receipt-time range.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
	// GetRequestHistoryByID returns every retained request-log event for one request.
	GetRequestHistoryByID(ctx context.Context, in *GetRequestHistoryByIDRequest, opts ...grpc.CallOption) (*GetRequestHistoryByIDResponse, error)
	// GetRequestHistoryByChangeURI returns retained request histories for an exact pinned change URI.
	GetRequestHistoryByChangeURI(ctx context.Context, in *GetRequestHistoryByChangeURIRequest, opts ...grpc.CallOption) (*GetRequestHistoryByChangeURIResponse, 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 request-summary or request-history APIs.
	Cancel(context.Context, *CancelRequest) (*CancelResponse, error)
	// GetRequestSummaryByID returns the current materialized status of one request.
	GetRequestSummaryByID(context.Context, *GetRequestSummaryByIDRequest) (*GetRequestSummaryByIDResponse, error)
	// GetRequestSummaryByChangeURI returns current materialized statuses for an exact pinned change URI.
	GetRequestSummaryByChangeURI(context.Context, *GetRequestSummaryByChangeURIRequest) (*GetRequestSummaryByChangeURIResponse, error)
	// List returns requests received for one queue during a bounded receipt-time range.
	List(context.Context, *ListRequest) (*ListResponse, error)
	// GetRequestHistoryByID returns every retained request-log event for one request.
	GetRequestHistoryByID(context.Context, *GetRequestHistoryByIDRequest) (*GetRequestHistoryByIDResponse, error)
	// GetRequestHistoryByChangeURI returns retained request histories for an exact pinned change URI.
	GetRequestHistoryByChangeURI(context.Context, *GetRequestHistoryByChangeURIRequest) (*GetRequestHistoryByChangeURIResponse, 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

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) List

func (UnimplementedSubmitQueueGatewayServer) Ping

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