queuespb

package
v0.0.0-...-0ec5fa5 Latest Latest
Warning

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

 Go to latest Published: Feb 6, 2025 License: Apache-2.0 Imports: 9 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_nitric_proto_queues_v1_queues_proto protoreflect.FileDescriptor
View Source 
var Queues_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.proto.queues.v1.Queues",
	HandlerType: (*QueuesServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Enqueue",
			Handler:    _Queues_Enqueue_Handler,
		},
		{
			MethodName: "Dequeue",
			Handler:    _Queues_Dequeue_Handler,
		},
		{
			MethodName: "Complete",
			Handler:    _Queues_Complete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "nitric/proto/queues/v1/queues.proto",
}

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

Functions

func RegisterQueuesServer 

func RegisterQueuesServer(s grpc.ServiceRegistrar, srv QueuesServer)

Types

type DequeuedMessage 

type DequeuedMessage struct {
	LeaseId string        `protobuf:"bytes,1,opt,name=lease_id,json=leaseId,proto3" json:"lease_id,omitempty"`
	Message *QueueMessage `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*DequeuedMessage) Descriptor deprecated 

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

Deprecated: Use DequeuedMessage.ProtoReflect.Descriptor instead.

func (*DequeuedMessage) GetLeaseId 

func (x *DequeuedMessage) GetLeaseId() string

func (*DequeuedMessage) GetMessage 

func (x *DequeuedMessage) GetMessage() *QueueMessage

func (*DequeuedMessage) ProtoMessage 

func (*DequeuedMessage) ProtoMessage()

func (*DequeuedMessage) ProtoReflect 

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

func (*DequeuedMessage) Reset 

func (x *DequeuedMessage) Reset()

func (*DequeuedMessage) String 

func (x *DequeuedMessage) String() string

type FailedEnqueueMessage 

type FailedEnqueueMessage struct {

	// The message that failed to be pushed
	Message *QueueMessage `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// A description of the failure
	Details string `protobuf:"bytes,2,opt,name=details,proto3" json:"details,omitempty"`
	// contains filtered or unexported fields
}

func (*FailedEnqueueMessage) Descriptor deprecated 

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

Deprecated: Use FailedEnqueueMessage.ProtoReflect.Descriptor instead.

func (*FailedEnqueueMessage) GetDetails 

func (x *FailedEnqueueMessage) GetDetails() string

func (*FailedEnqueueMessage) GetMessage 

func (x *FailedEnqueueMessage) GetMessage() *QueueMessage

func (*FailedEnqueueMessage) ProtoMessage 

func (*FailedEnqueueMessage) ProtoMessage()

func (*FailedEnqueueMessage) ProtoReflect 

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

func (*FailedEnqueueMessage) Reset 

func (x *FailedEnqueueMessage) Reset()

func (*FailedEnqueueMessage) String 

func (x *FailedEnqueueMessage) String() string

type QueueCompleteRequest 

type QueueCompleteRequest struct {

	// The nitric name for the queue
	//
	//	this will automatically be resolved to the provider specific queue identifier.
	QueueName string `protobuf:"bytes,1,opt,name=queue_name,json=queueName,proto3" json:"queue_name,omitempty"`
	// Lease id of the message to be completed
	LeaseId string `protobuf:"bytes,2,opt,name=lease_id,json=leaseId,proto3" json:"lease_id,omitempty"`
	// contains filtered or unexported fields
}

func (*QueueCompleteRequest) Descriptor deprecated 

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

Deprecated: Use QueueCompleteRequest.ProtoReflect.Descriptor instead.

func (*QueueCompleteRequest) GetLeaseId 

func (x *QueueCompleteRequest) GetLeaseId() string

func (*QueueCompleteRequest) GetQueueName 

func (x *QueueCompleteRequest) GetQueueName() string

func (*QueueCompleteRequest) ProtoMessage 

func (*QueueCompleteRequest) ProtoMessage()

func (*QueueCompleteRequest) ProtoReflect 

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

func (*QueueCompleteRequest) Reset 

func (x *QueueCompleteRequest) Reset()

func (*QueueCompleteRequest) String 

func (x *QueueCompleteRequest) String() string

type QueueCompleteResponse 

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

func (*QueueCompleteResponse) Descriptor deprecated 

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

Deprecated: Use QueueCompleteResponse.ProtoReflect.Descriptor instead.

func (*QueueCompleteResponse) ProtoMessage 

func (*QueueCompleteResponse) ProtoMessage()

func (*QueueCompleteResponse) ProtoReflect 

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

func (*QueueCompleteResponse) Reset 

func (x *QueueCompleteResponse) Reset()

func (*QueueCompleteResponse) String 

func (x *QueueCompleteResponse) String() string

type QueueDequeueRequest 

type QueueDequeueRequest struct {

	// The nitric name for the queue
	// this will automatically be resolved to the provider specific queue identifier.
	QueueName string `protobuf:"bytes,1,opt,name=queue_name,json=queueName,proto3" json:"queue_name,omitempty"`
	// The max number of messages to pop off the queue, may be capped by provider specific limitations
	Depth int32 `protobuf:"varint,2,opt,name=depth,proto3" json:"depth,omitempty"`
	// contains filtered or unexported fields
}

func (*QueueDequeueRequest) Descriptor deprecated 

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

Deprecated: Use QueueDequeueRequest.ProtoReflect.Descriptor instead.

func (*QueueDequeueRequest) GetDepth 

func (x *QueueDequeueRequest) GetDepth() int32

func (*QueueDequeueRequest) GetQueueName 

func (x *QueueDequeueRequest) GetQueueName() string

func (*QueueDequeueRequest) ProtoMessage 

func (*QueueDequeueRequest) ProtoMessage()

func (*QueueDequeueRequest) ProtoReflect 

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

func (*QueueDequeueRequest) Reset 

func (x *QueueDequeueRequest) Reset()

func (*QueueDequeueRequest) String 

func (x *QueueDequeueRequest) String() string

type QueueDequeueResponse 

type QueueDequeueResponse struct {

	// Array of messages popped off the queue
	Messages []*DequeuedMessage `protobuf:"bytes,1,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

func (*QueueDequeueResponse) Descriptor deprecated 

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

Deprecated: Use QueueDequeueResponse.ProtoReflect.Descriptor instead.

func (*QueueDequeueResponse) GetMessages 

func (x *QueueDequeueResponse) GetMessages() []*DequeuedMessage

func (*QueueDequeueResponse) ProtoMessage 

func (*QueueDequeueResponse) ProtoMessage()

func (*QueueDequeueResponse) ProtoReflect 

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

func (*QueueDequeueResponse) Reset 

func (x *QueueDequeueResponse) Reset()

func (*QueueDequeueResponse) String 

func (x *QueueDequeueResponse) String() string

type QueueEnqueueRequest 

type QueueEnqueueRequest struct {

	// The Nitric name for the queue
	// this will automatically be resolved to the provider specific queue identifier.
	QueueName string `protobuf:"bytes,1,opt,name=queue_name,json=queueName,proto3" json:"queue_name,omitempty"`
	// Array of messages to push to the queue
	Messages []*QueueMessage `protobuf:"bytes,2,rep,name=messages,proto3" json:"messages,omitempty"`
	// contains filtered or unexported fields
}

func (*QueueEnqueueRequest) Descriptor deprecated 

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

Deprecated: Use QueueEnqueueRequest.ProtoReflect.Descriptor instead.

func (*QueueEnqueueRequest) GetMessages 

func (x *QueueEnqueueRequest) GetMessages() []*QueueMessage

func (*QueueEnqueueRequest) GetQueueName 

func (x *QueueEnqueueRequest) GetQueueName() string

func (*QueueEnqueueRequest) ProtoMessage 

func (*QueueEnqueueRequest) ProtoMessage()

func (*QueueEnqueueRequest) ProtoReflect 

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

func (*QueueEnqueueRequest) Reset 

func (x *QueueEnqueueRequest) Reset()

func (*QueueEnqueueRequest) String 

func (x *QueueEnqueueRequest) String() string

type QueueEnqueueResponse 

type QueueEnqueueResponse struct {

	// A list of messages that failed to be queued
	FailedMessages []*FailedEnqueueMessage `protobuf:"bytes,1,rep,name=failed_messages,json=failedMessages,proto3" json:"failed_messages,omitempty"`
	// contains filtered or unexported fields
}

Response for sending messages to a queue

func (*QueueEnqueueResponse) Descriptor deprecated 

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

Deprecated: Use QueueEnqueueResponse.ProtoReflect.Descriptor instead.

func (*QueueEnqueueResponse) GetFailedMessages 

func (x *QueueEnqueueResponse) GetFailedMessages() []*FailedEnqueueMessage

func (*QueueEnqueueResponse) ProtoMessage 

func (*QueueEnqueueResponse) ProtoMessage()

func (*QueueEnqueueResponse) ProtoReflect 

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

func (*QueueEnqueueResponse) Reset 

func (x *QueueEnqueueResponse) Reset()

func (*QueueEnqueueResponse) String 

func (x *QueueEnqueueResponse) String() string

type QueueMessage 

type QueueMessage struct {

	// The queue message contents
	//
	// Types that are assignable to Content:
	//
	//	*QueueMessage_StructPayload
	Content isQueueMessage_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

An message to be sent to a queue.

func (*QueueMessage) Descriptor deprecated 

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

Deprecated: Use QueueMessage.ProtoReflect.Descriptor instead.

func (*QueueMessage) GetContent 

func (m *QueueMessage) GetContent() isQueueMessage_Content

func (*QueueMessage) GetStructPayload 

func (x *QueueMessage) GetStructPayload() *structpb.Struct

func (*QueueMessage) ProtoMessage 

func (*QueueMessage) ProtoMessage()

func (*QueueMessage) ProtoReflect 

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

func (*QueueMessage) Reset 

func (x *QueueMessage) Reset()

func (*QueueMessage) String 

func (x *QueueMessage) String() string

type QueueMessage_StructPayload 

type QueueMessage_StructPayload struct {
	StructPayload *structpb.Struct `protobuf:"bytes,1,opt,name=struct_payload,json=structPayload,proto3,oneof"`
}

type QueuesClient 

type QueuesClient interface {
	// Send message(s) to a queue
	Enqueue(ctx context.Context, in *QueueEnqueueRequest, opts ...grpc.CallOption) (*QueueEnqueueResponse, error)
	// Receive message(s) from a queue
	Dequeue(ctx context.Context, in *QueueDequeueRequest, opts ...grpc.CallOption) (*QueueDequeueResponse, error)
	// Complete an message previously popped from a queue
	Complete(ctx context.Context, in *QueueCompleteRequest, opts ...grpc.CallOption) (*QueueCompleteResponse, error)
}

QueuesClient is the client API for Queues 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 NewQueuesClient 

func NewQueuesClient(cc grpc.ClientConnInterface) QueuesClient

type QueuesServer 

type QueuesServer interface {
	// Send message(s) to a queue
	Enqueue(context.Context, *QueueEnqueueRequest) (*QueueEnqueueResponse, error)
	// Receive message(s) from a queue
	Dequeue(context.Context, *QueueDequeueRequest) (*QueueDequeueResponse, error)
	// Complete an message previously popped from a queue
	Complete(context.Context, *QueueCompleteRequest) (*QueueCompleteResponse, error)
}

QueuesServer is the server API for Queues service. All implementations should embed UnimplementedQueuesServer for forward compatibility

type UnimplementedQueuesServer 

type UnimplementedQueuesServer struct {
}

UnimplementedQueuesServer should be embedded to have forward compatible implementations.

func (UnimplementedQueuesServer) Complete 

func (UnimplementedQueuesServer) Complete(context.Context, *QueueCompleteRequest) (*QueueCompleteResponse, error)

func (UnimplementedQueuesServer) Dequeue 

func (UnimplementedQueuesServer) Dequeue(context.Context, *QueueDequeueRequest) (*QueueDequeueResponse, error)

func (UnimplementedQueuesServer) Enqueue 

func (UnimplementedQueuesServer) Enqueue(context.Context, *QueueEnqueueRequest) (*QueueEnqueueResponse, error)

type UnsafeQueuesServer 

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

UnsafeQueuesServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to QueuesServer 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.