v1

package
v0.3.1 Latest Latest
Warning

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

 Go to latest Published: Jul 15, 2021 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var Event_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.event.v1.Event",
	HandlerType: (*EventServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Publish",
			Handler:    _Event_Publish_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "event/v1/event.proto",
}

Event_ServiceDesc is the grpc.ServiceDesc for Event 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 Faas_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.faas.v1.Faas",
	HandlerType: (*FaasServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "TriggerStream",
			Handler:       _Faas_TriggerStream_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "faas/v1/faas.proto",
}

Faas_ServiceDesc is the grpc.ServiceDesc for Faas 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_event_v1_event_proto protoreflect.FileDescriptor
View Source 
var File_faas_v1_faas_proto protoreflect.FileDescriptor
View Source 
var File_kv_v1_kv_proto protoreflect.FileDescriptor
View Source 
var File_queue_v1_queue_proto protoreflect.FileDescriptor
View Source 
var File_storage_v1_storage_proto protoreflect.FileDescriptor
View Source 
var KeyValue_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.kv.v1.KeyValue",
	HandlerType: (*KeyValueServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _KeyValue_Get_Handler,
		},
		{
			MethodName: "Put",
			Handler:    _KeyValue_Put_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _KeyValue_Delete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "kv/v1/kv.proto",
}

KeyValue_ServiceDesc is the grpc.ServiceDesc for KeyValue 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 Queue_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.queue.v1.Queue",
	HandlerType: (*QueueServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Send",
			Handler:    _Queue_Send_Handler,
		},
		{
			MethodName: "SendBatch",
			Handler:    _Queue_SendBatch_Handler,
		},
		{
			MethodName: "Receive",
			Handler:    _Queue_Receive_Handler,
		},
		{
			MethodName: "Complete",
			Handler:    _Queue_Complete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "queue/v1/queue.proto",
}

Queue_ServiceDesc is the grpc.ServiceDesc for Queue 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 Storage_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.storage.v1.Storage",
	HandlerType: (*StorageServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _Storage_Read_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _Storage_Write_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Storage_Delete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "storage/v1/storage.proto",
}

Storage_ServiceDesc is the grpc.ServiceDesc for Storage 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 Topic_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.event.v1.Topic",
	HandlerType: (*TopicServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "List",
			Handler:    _Topic_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "event/v1/event.proto",
}

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

Functions

func RegisterEventServer 

func RegisterEventServer(s grpc.ServiceRegistrar, srv EventServer)

func RegisterFaasServer added in v0.3.0 

func RegisterFaasServer(s grpc.ServiceRegistrar, srv FaasServer)

func RegisterKeyValueServer 

func RegisterKeyValueServer(s grpc.ServiceRegistrar, srv KeyValueServer)

func RegisterQueueServer 

func RegisterQueueServer(s grpc.ServiceRegistrar, srv QueueServer)

func RegisterStorageServer 

func RegisterStorageServer(s grpc.ServiceRegistrar, srv StorageServer)

func RegisterTopicServer 

func RegisterTopicServer(s grpc.ServiceRegistrar, srv TopicServer)

Types

type ClientMessage added in v0.3.0 

type ClientMessage struct {

	// Client message ID, used to pair requests/responses
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Content:
	//	*ClientMessage_InitRequest
	//	*ClientMessage_TriggerResponse
	Content isClientMessage_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Messages the client is able to send to the server

func (*ClientMessage) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.

func (*ClientMessage) GetContent added in v0.3.0 

func (m *ClientMessage) GetContent() isClientMessage_Content

func (*ClientMessage) GetId added in v0.3.0 

func (x *ClientMessage) GetId() string

func (*ClientMessage) GetInitRequest added in v0.3.0 

func (x *ClientMessage) GetInitRequest() *InitRequest

func (*ClientMessage) GetTriggerResponse added in v0.3.0 

func (x *ClientMessage) GetTriggerResponse() *TriggerResponse

func (*ClientMessage) ProtoMessage added in v0.3.0 

func (*ClientMessage) ProtoMessage()

func (*ClientMessage) ProtoReflect added in v0.3.0 

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

func (*ClientMessage) Reset added in v0.3.0 

func (x *ClientMessage) Reset()

func (*ClientMessage) String added in v0.3.0 

func (x *ClientMessage) String() string

type ClientMessage_InitRequest added in v0.3.0 

type ClientMessage_InitRequest struct {
	// Client initialisation request
	InitRequest *InitRequest `protobuf:"bytes,2,opt,name=init_request,json=initRequest,proto3,oneof"`
}

type ClientMessage_TriggerResponse added in v0.3.0 

type ClientMessage_TriggerResponse struct {
	// Client responsding with result of
	// a trigger
	TriggerResponse *TriggerResponse `protobuf:"bytes,3,opt,name=trigger_response,json=triggerResponse,proto3,oneof"`
}

type EventClient 

type EventClient interface {
	// Publishes an message to a given topic
	Publish(ctx context.Context, in *EventPublishRequest, opts ...grpc.CallOption) (*EventPublishResponse, error)
}

EventClient is the client API for Event 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 NewEventClient 

func NewEventClient(cc grpc.ClientConnInterface) EventClient

type EventPublishRequest 

type EventPublishRequest struct {

	// The name of the topic to publish the event to
	Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
	// The event to be published
	Event *NitricEvent `protobuf:"bytes,2,opt,name=event,proto3" json:"event,omitempty"`
	// contains filtered or unexported fields
}

Request to publish an event to a topic

func (*EventPublishRequest) Descriptor deprecated 

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

Deprecated: Use EventPublishRequest.ProtoReflect.Descriptor instead.

func (*EventPublishRequest) GetEvent 

func (x *EventPublishRequest) GetEvent() *NitricEvent

func (*EventPublishRequest) GetTopic 

func (x *EventPublishRequest) GetTopic() string

func (*EventPublishRequest) ProtoMessage 

func (*EventPublishRequest) ProtoMessage()

func (*EventPublishRequest) ProtoReflect 

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

func (*EventPublishRequest) Reset 

func (x *EventPublishRequest) Reset()

func (*EventPublishRequest) String 

func (x *EventPublishRequest) String() string

type EventPublishResponse 

type EventPublishResponse struct {

	// The id of the published message
	// When an id was not supplied
	// one should be automatically generated
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Result of publishing an event

func (*EventPublishResponse) Descriptor deprecated 

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

Deprecated: Use EventPublishResponse.ProtoReflect.Descriptor instead.

func (*EventPublishResponse) GetId 

func (x *EventPublishResponse) GetId() string

func (*EventPublishResponse) ProtoMessage 

func (*EventPublishResponse) ProtoMessage()

func (*EventPublishResponse) ProtoReflect 

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

func (*EventPublishResponse) Reset 

func (x *EventPublishResponse) Reset()

func (*EventPublishResponse) String 

func (x *EventPublishResponse) String() string

type EventServer 

type EventServer interface {
	// Publishes an message to a given topic
	Publish(context.Context, *EventPublishRequest) (*EventPublishResponse, error)
	// contains filtered or unexported methods
}

EventServer is the server API for Event service. All implementations must embed UnimplementedEventServer for forward compatibility

type FaasClient added in v0.3.0 

type FaasClient interface {
	// Begin streaming triggers/response to/from the membrane
	TriggerStream(ctx context.Context, opts ...grpc.CallOption) (Faas_TriggerStreamClient, error)
}

FaasClient is the client API for Faas 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 NewFaasClient added in v0.3.0 

func NewFaasClient(cc grpc.ClientConnInterface) FaasClient

type FaasServer added in v0.3.0 

type FaasServer interface {
	// Begin streaming triggers/response to/from the membrane
	TriggerStream(Faas_TriggerStreamServer) error
	// contains filtered or unexported methods
}

FaasServer is the server API for Faas service. All implementations must embed UnimplementedFaasServer for forward compatibility

type Faas_TriggerStreamClient added in v0.3.0 

type Faas_TriggerStreamClient interface {
	Send(*ClientMessage) error
	Recv() (*ServerMessage, error)
	grpc.ClientStream
}

type Faas_TriggerStreamServer added in v0.3.0 

type Faas_TriggerStreamServer interface {
	Send(*ServerMessage) error
	Recv() (*ClientMessage, error)
	grpc.ServerStream
}

type FailedTask 

type FailedTask struct {

	// The task that failed to be pushed
	Task *NitricTask `protobuf:"bytes,1,opt,name=task,proto3" json:"task,omitempty"`
	// A message describing the failure
	Message string `protobuf:"bytes,2,opt,name=message,proto3" json:"message,omitempty"`
	// contains filtered or unexported fields
}

func (*FailedTask) Descriptor deprecated 

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

Deprecated: Use FailedTask.ProtoReflect.Descriptor instead.

func (*FailedTask) GetMessage 

func (x *FailedTask) GetMessage() string

func (*FailedTask) GetTask 

func (x *FailedTask) GetTask() *NitricTask

func (*FailedTask) ProtoMessage 

func (*FailedTask) ProtoMessage()

func (*FailedTask) ProtoReflect 

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

func (*FailedTask) Reset 

func (x *FailedTask) Reset()

func (*FailedTask) String 

func (x *FailedTask) String() string

type HttpResponseContext added in v0.3.0 

type HttpResponseContext struct {

	// The request headers...
	Headers map[string]string `` /* 155-byte string literal not displayed */
	// The HTTP status of the request
	Status int32 `protobuf:"varint,2,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

Specific HttpResponse message Note this does not have to be handled by the User at all but they will have the option of control If they choose...

func (*HttpResponseContext) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use HttpResponseContext.ProtoReflect.Descriptor instead.

func (*HttpResponseContext) GetHeaders added in v0.3.0 

func (x *HttpResponseContext) GetHeaders() map[string]string

func (*HttpResponseContext) GetStatus added in v0.3.0 

func (x *HttpResponseContext) GetStatus() int32

func (*HttpResponseContext) ProtoMessage added in v0.3.0 

func (*HttpResponseContext) ProtoMessage()

func (*HttpResponseContext) ProtoReflect added in v0.3.0 

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

func (*HttpResponseContext) Reset added in v0.3.0 

func (x *HttpResponseContext) Reset()

func (*HttpResponseContext) String added in v0.3.0 

func (x *HttpResponseContext) String() string

type HttpTriggerContext added in v0.3.0 

type HttpTriggerContext struct {

	// The request method
	Method string `protobuf:"bytes,1,opt,name=method,proto3" json:"method,omitempty"`
	// The path of the request
	Path string `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	// The request headers
	Headers map[string]string `` /* 155-byte string literal not displayed */
	// The query params (if parseable by the membrane)
	QueryParams map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*HttpTriggerContext) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use HttpTriggerContext.ProtoReflect.Descriptor instead.

func (*HttpTriggerContext) GetHeaders added in v0.3.0 

func (x *HttpTriggerContext) GetHeaders() map[string]string

func (*HttpTriggerContext) GetMethod added in v0.3.0 

func (x *HttpTriggerContext) GetMethod() string

func (*HttpTriggerContext) GetPath added in v0.3.0 

func (x *HttpTriggerContext) GetPath() string

func (*HttpTriggerContext) GetQueryParams added in v0.3.0 

func (x *HttpTriggerContext) GetQueryParams() map[string]string

func (*HttpTriggerContext) ProtoMessage added in v0.3.0 

func (*HttpTriggerContext) ProtoMessage()

func (*HttpTriggerContext) ProtoReflect added in v0.3.0 

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

func (*HttpTriggerContext) Reset added in v0.3.0 

func (x *HttpTriggerContext) Reset()

func (*HttpTriggerContext) String added in v0.3.0 

func (x *HttpTriggerContext) String() string

type InitRequest added in v0.3.0 

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

Placeholder message

func (*InitRequest) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use InitRequest.ProtoReflect.Descriptor instead.

func (*InitRequest) ProtoMessage added in v0.3.0 

func (*InitRequest) ProtoMessage()

func (*InitRequest) ProtoReflect added in v0.3.0 

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

func (*InitRequest) Reset added in v0.3.0 

func (x *InitRequest) Reset()

func (*InitRequest) String added in v0.3.0 

func (x *InitRequest) String() string

type InitResponse added in v0.3.0 

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

Placeholder message

func (*InitResponse) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use InitResponse.ProtoReflect.Descriptor instead.

func (*InitResponse) ProtoMessage added in v0.3.0 

func (*InitResponse) ProtoMessage()

func (*InitResponse) ProtoReflect added in v0.3.0 

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

func (*InitResponse) Reset added in v0.3.0 

func (x *InitResponse) Reset()

func (*InitResponse) String added in v0.3.0 

func (x *InitResponse) String() string

type KeyValueClient 

type KeyValueClient interface {
	// Get an existing key
	Get(ctx context.Context, in *KeyValueGetRequest, opts ...grpc.CallOption) (*KeyValueGetResponse, error)
	// Create a new or overwrite and existing key
	Put(ctx context.Context, in *KeyValuePutRequest, opts ...grpc.CallOption) (*KeyValuePutResponse, error)
	// Delete an existing
	Delete(ctx context.Context, in *KeyValueDeleteRequest, opts ...grpc.CallOption) (*KeyValueDeleteResponse, error)
}

KeyValueClient is the client API for KeyValue 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 NewKeyValueClient 

func NewKeyValueClient(cc grpc.ClientConnInterface) KeyValueClient

type KeyValueDeleteRequest 

type KeyValueDeleteRequest struct {

	// The collection containing the existing keyValue to be deleted
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// The unique key of the keyValue to delete
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValueDeleteRequest) Descriptor deprecated 

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

Deprecated: Use KeyValueDeleteRequest.ProtoReflect.Descriptor instead.

func (*KeyValueDeleteRequest) GetCollection 

func (x *KeyValueDeleteRequest) GetCollection() string

func (*KeyValueDeleteRequest) GetKey 

func (x *KeyValueDeleteRequest) GetKey() string

func (*KeyValueDeleteRequest) ProtoMessage 

func (*KeyValueDeleteRequest) ProtoMessage()

func (*KeyValueDeleteRequest) ProtoReflect 

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

func (*KeyValueDeleteRequest) Reset 

func (x *KeyValueDeleteRequest) Reset()

func (*KeyValueDeleteRequest) String 

func (x *KeyValueDeleteRequest) String() string

type KeyValueDeleteResponse 

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

func (*KeyValueDeleteResponse) Descriptor deprecated 

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

Deprecated: Use KeyValueDeleteResponse.ProtoReflect.Descriptor instead.

func (*KeyValueDeleteResponse) ProtoMessage 

func (*KeyValueDeleteResponse) ProtoMessage()

func (*KeyValueDeleteResponse) ProtoReflect 

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

func (*KeyValueDeleteResponse) Reset 

func (x *KeyValueDeleteResponse) Reset()

func (*KeyValueDeleteResponse) String 

func (x *KeyValueDeleteResponse) String() string

type KeyValueGetRequest 

type KeyValueGetRequest struct {

	// The collection to retrieve the keyValue from
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// The unique key of the keyValue to retrieve
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValueGetRequest) Descriptor deprecated 

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

Deprecated: Use KeyValueGetRequest.ProtoReflect.Descriptor instead.

func (*KeyValueGetRequest) GetCollection 

func (x *KeyValueGetRequest) GetCollection() string

func (*KeyValueGetRequest) GetKey 

func (x *KeyValueGetRequest) GetKey() string

func (*KeyValueGetRequest) ProtoMessage 

func (*KeyValueGetRequest) ProtoMessage()

func (*KeyValueGetRequest) ProtoReflect 

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

func (*KeyValueGetRequest) Reset 

func (x *KeyValueGetRequest) Reset()

func (*KeyValueGetRequest) String 

func (x *KeyValueGetRequest) String() string

type KeyValueGetResponse 

type KeyValueGetResponse struct {

	// The retrieved value
	Value *structpb.Struct `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValueGetResponse) Descriptor deprecated 

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

Deprecated: Use KeyValueGetResponse.ProtoReflect.Descriptor instead.

func (*KeyValueGetResponse) GetValue 

func (x *KeyValueGetResponse) GetValue() *structpb.Struct

func (*KeyValueGetResponse) ProtoMessage 

func (*KeyValueGetResponse) ProtoMessage()

func (*KeyValueGetResponse) ProtoReflect 

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

func (*KeyValueGetResponse) Reset 

func (x *KeyValueGetResponse) Reset()

func (*KeyValueGetResponse) String 

func (x *KeyValueGetResponse) String() string

type KeyValuePutRequest 

type KeyValuePutRequest struct {

	// The collection containing the existing keyValue to be inserted or updated.
	Collection string `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// The unique key of the keyValue to put
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// A simple JSON object
	Value *structpb.Struct `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*KeyValuePutRequest) Descriptor deprecated 

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

Deprecated: Use KeyValuePutRequest.ProtoReflect.Descriptor instead.

func (*KeyValuePutRequest) GetCollection 

func (x *KeyValuePutRequest) GetCollection() string

func (*KeyValuePutRequest) GetKey 

func (x *KeyValuePutRequest) GetKey() string

func (*KeyValuePutRequest) GetValue 

func (x *KeyValuePutRequest) GetValue() *structpb.Struct

func (*KeyValuePutRequest) ProtoMessage 

func (*KeyValuePutRequest) ProtoMessage()

func (*KeyValuePutRequest) ProtoReflect 

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

func (*KeyValuePutRequest) Reset 

func (x *KeyValuePutRequest) Reset()

func (*KeyValuePutRequest) String 

func (x *KeyValuePutRequest) String() string

type KeyValuePutResponse 

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

func (*KeyValuePutResponse) Descriptor deprecated 

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

Deprecated: Use KeyValuePutResponse.ProtoReflect.Descriptor instead.

func (*KeyValuePutResponse) ProtoMessage 

func (*KeyValuePutResponse) ProtoMessage()

func (*KeyValuePutResponse) ProtoReflect 

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

func (*KeyValuePutResponse) Reset 

func (x *KeyValuePutResponse) Reset()

func (*KeyValuePutResponse) String 

func (x *KeyValuePutResponse) String() string

type KeyValueServer 

type KeyValueServer interface {
	// Get an existing key
	Get(context.Context, *KeyValueGetRequest) (*KeyValueGetResponse, error)
	// Create a new or overwrite and existing key
	Put(context.Context, *KeyValuePutRequest) (*KeyValuePutResponse, error)
	// Delete an existing
	Delete(context.Context, *KeyValueDeleteRequest) (*KeyValueDeleteResponse, error)
	// contains filtered or unexported methods
}

KeyValueServer is the server API for KeyValue service. All implementations must embed UnimplementedKeyValueServer for forward compatibility

type NitricEvent 

type NitricEvent struct {

	// A Unique ID for the Nitric Event
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// A content hint for the events payload
	PayloadType string `protobuf:"bytes,2,opt,name=payload_type,json=payloadType,proto3" json:"payload_type,omitempty"`
	// The payload of the event
	Payload *structpb.Struct `protobuf:"bytes,3,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

Nitric Event Model

func (*NitricEvent) Descriptor deprecated 

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

Deprecated: Use NitricEvent.ProtoReflect.Descriptor instead.

func (*NitricEvent) GetId 

func (x *NitricEvent) GetId() string

func (*NitricEvent) GetPayload 

func (x *NitricEvent) GetPayload() *structpb.Struct

func (*NitricEvent) GetPayloadType 

func (x *NitricEvent) GetPayloadType() string

func (*NitricEvent) ProtoMessage 

func (*NitricEvent) ProtoMessage()

func (*NitricEvent) ProtoReflect 

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

func (*NitricEvent) Reset 

func (x *NitricEvent) Reset()

func (*NitricEvent) String 

func (x *NitricEvent) String() string

type NitricTask 

type NitricTask struct {

	// A unique id for the task
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The lease id unique to the pop request, this must be used to complete, extend the lease or release the task.
	LeaseId string `protobuf:"bytes,2,opt,name=lease_id,json=leaseId,proto3" json:"lease_id,omitempty"`
	// A content hint for the tasks payload
	PayloadType string `protobuf:"bytes,3,opt,name=payload_type,json=payloadType,proto3" json:"payload_type,omitempty"`
	// The payload of the task
	Payload *structpb.Struct `protobuf:"bytes,4,opt,name=payload,proto3" json:"payload,omitempty"`
	// contains filtered or unexported fields
}

A task to be sent or received from a queue.

func (*NitricTask) Descriptor deprecated 

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

Deprecated: Use NitricTask.ProtoReflect.Descriptor instead.

func (*NitricTask) GetId 

func (x *NitricTask) GetId() string

func (*NitricTask) GetLeaseId 

func (x *NitricTask) GetLeaseId() string

func (*NitricTask) GetPayload 

func (x *NitricTask) GetPayload() *structpb.Struct

func (*NitricTask) GetPayloadType 

func (x *NitricTask) GetPayloadType() string

func (*NitricTask) ProtoMessage 

func (*NitricTask) ProtoMessage()

func (*NitricTask) ProtoReflect 

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

func (*NitricTask) Reset 

func (x *NitricTask) Reset()

func (*NitricTask) String 

func (x *NitricTask) String() string

type NitricTopic 

type NitricTopic struct {

	// The Nitric name for the topic
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Represents an event topic

func (*NitricTopic) Descriptor deprecated 

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

Deprecated: Use NitricTopic.ProtoReflect.Descriptor instead.

func (*NitricTopic) GetName 

func (x *NitricTopic) GetName() string

func (*NitricTopic) ProtoMessage 

func (*NitricTopic) ProtoMessage()

func (*NitricTopic) ProtoReflect 

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

func (*NitricTopic) Reset 

func (x *NitricTopic) Reset()

func (*NitricTopic) String 

func (x *NitricTopic) String() string

type QueueClient 

type QueueClient interface {
	// Send a single event to a queue
	Send(ctx context.Context, in *QueueSendRequest, opts ...grpc.CallOption) (*QueueSendResponse, error)
	// Send multiple events to a queue
	SendBatch(ctx context.Context, in *QueueSendBatchRequest, opts ...grpc.CallOption) (*QueueSendBatchResponse, error)
	// Receive event(s) off a queue
	Receive(ctx context.Context, in *QueueReceiveRequest, opts ...grpc.CallOption) (*QueueReceiveResponse, error)
	// Complete an event previously popped from a queue
	Complete(ctx context.Context, in *QueueCompleteRequest, opts ...grpc.CallOption) (*QueueCompleteResponse, error)
}

QueueClient is the client API for Queue 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 NewQueueClient 

func NewQueueClient(cc grpc.ClientConnInterface) QueueClient

type QueueCompleteRequest 

type QueueCompleteRequest struct {

	// The nitric name for the queue
	//  this will automatically be resolved to the provider specific queue identifier.
	Queue string `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// Lease id of the task 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) GetQueue 

func (x *QueueCompleteRequest) GetQueue() 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 QueueReceiveRequest 

type QueueReceiveRequest struct {

	// The nitric name for the queue
	// this will automatically be resolved to the provider specific queue identifier.
	Queue string `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// The max number of items 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 (*QueueReceiveRequest) Descriptor deprecated 

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

Deprecated: Use QueueReceiveRequest.ProtoReflect.Descriptor instead.

func (*QueueReceiveRequest) GetDepth 

func (x *QueueReceiveRequest) GetDepth() int32

func (*QueueReceiveRequest) GetQueue 

func (x *QueueReceiveRequest) GetQueue() string

func (*QueueReceiveRequest) ProtoMessage 

func (*QueueReceiveRequest) ProtoMessage()

func (*QueueReceiveRequest) ProtoReflect 

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

func (*QueueReceiveRequest) Reset 

func (x *QueueReceiveRequest) Reset()

func (*QueueReceiveRequest) String 

func (x *QueueReceiveRequest) String() string

type QueueReceiveResponse 

type QueueReceiveResponse struct {

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

func (*QueueReceiveResponse) Descriptor deprecated 

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

Deprecated: Use QueueReceiveResponse.ProtoReflect.Descriptor instead.

func (*QueueReceiveResponse) GetTasks 

func (x *QueueReceiveResponse) GetTasks() []*NitricTask

func (*QueueReceiveResponse) ProtoMessage 

func (*QueueReceiveResponse) ProtoMessage()

func (*QueueReceiveResponse) ProtoReflect 

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

func (*QueueReceiveResponse) Reset 

func (x *QueueReceiveResponse) Reset()

func (*QueueReceiveResponse) String 

func (x *QueueReceiveResponse) String() string

type QueueSendBatchRequest 

type QueueSendBatchRequest struct {

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

func (*QueueSendBatchRequest) Descriptor deprecated 

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

Deprecated: Use QueueSendBatchRequest.ProtoReflect.Descriptor instead.

func (*QueueSendBatchRequest) GetQueue 

func (x *QueueSendBatchRequest) GetQueue() string

func (*QueueSendBatchRequest) GetTasks 

func (x *QueueSendBatchRequest) GetTasks() []*NitricTask

func (*QueueSendBatchRequest) ProtoMessage 

func (*QueueSendBatchRequest) ProtoMessage()

func (*QueueSendBatchRequest) ProtoReflect 

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

func (*QueueSendBatchRequest) Reset 

func (x *QueueSendBatchRequest) Reset()

func (*QueueSendBatchRequest) String 

func (x *QueueSendBatchRequest) String() string

type QueueSendBatchResponse 

type QueueSendBatchResponse struct {

	// A list of tasks that failed to be queued
	FailedTasks []*FailedTask `protobuf:"bytes,1,rep,name=failedTasks,proto3" json:"failedTasks,omitempty"`
	// contains filtered or unexported fields
}

Response for sending a collection of tasks

func (*QueueSendBatchResponse) Descriptor deprecated 

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

Deprecated: Use QueueSendBatchResponse.ProtoReflect.Descriptor instead.

func (*QueueSendBatchResponse) GetFailedTasks 

func (x *QueueSendBatchResponse) GetFailedTasks() []*FailedTask

func (*QueueSendBatchResponse) ProtoMessage 

func (*QueueSendBatchResponse) ProtoMessage()

func (*QueueSendBatchResponse) ProtoReflect 

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

func (*QueueSendBatchResponse) Reset 

func (x *QueueSendBatchResponse) Reset()

func (*QueueSendBatchResponse) String 

func (x *QueueSendBatchResponse) String() string

type QueueSendRequest 

type QueueSendRequest struct {

	// The Nitric name for the queue
	// this will automatically be resolved to the provider specific queue identifier.
	Queue string `protobuf:"bytes,1,opt,name=queue,proto3" json:"queue,omitempty"`
	// The task to push to the queue
	Task *NitricTask `protobuf:"bytes,2,opt,name=task,proto3" json:"task,omitempty"`
	// contains filtered or unexported fields
}

Request to push a single event to a queue

func (*QueueSendRequest) Descriptor deprecated 

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

Deprecated: Use QueueSendRequest.ProtoReflect.Descriptor instead.

func (*QueueSendRequest) GetQueue 

func (x *QueueSendRequest) GetQueue() string

func (*QueueSendRequest) GetTask 

func (x *QueueSendRequest) GetTask() *NitricTask

func (*QueueSendRequest) ProtoMessage 

func (*QueueSendRequest) ProtoMessage()

func (*QueueSendRequest) ProtoReflect 

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

func (*QueueSendRequest) Reset 

func (x *QueueSendRequest) Reset()

func (*QueueSendRequest) String 

func (x *QueueSendRequest) String() string

type QueueSendResponse 

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

Result of pushing a single task to a queue

func (*QueueSendResponse) Descriptor deprecated 

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

Deprecated: Use QueueSendResponse.ProtoReflect.Descriptor instead.

func (*QueueSendResponse) ProtoMessage 

func (*QueueSendResponse) ProtoMessage()

func (*QueueSendResponse) ProtoReflect 

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

func (*QueueSendResponse) Reset 

func (x *QueueSendResponse) Reset()

func (*QueueSendResponse) String 

func (x *QueueSendResponse) String() string

type QueueServer 

type QueueServer interface {
	// Send a single event to a queue
	Send(context.Context, *QueueSendRequest) (*QueueSendResponse, error)
	// Send multiple events to a queue
	SendBatch(context.Context, *QueueSendBatchRequest) (*QueueSendBatchResponse, error)
	// Receive event(s) off a queue
	Receive(context.Context, *QueueReceiveRequest) (*QueueReceiveResponse, error)
	// Complete an event previously popped from a queue
	Complete(context.Context, *QueueCompleteRequest) (*QueueCompleteResponse, error)
	// contains filtered or unexported methods
}

QueueServer is the server API for Queue service. All implementations must embed UnimplementedQueueServer for forward compatibility

type ServerMessage added in v0.3.0 

type ServerMessage struct {

	// Server message ID, used to pair requests/responses
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Content:
	//	*ServerMessage_InitResponse
	//	*ServerMessage_TriggerRequest
	Content isServerMessage_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

Messages the server is able to send to the client

func (*ServerMessage) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.

func (*ServerMessage) GetContent added in v0.3.0 

func (m *ServerMessage) GetContent() isServerMessage_Content

func (*ServerMessage) GetId added in v0.3.0 

func (x *ServerMessage) GetId() string

func (*ServerMessage) GetInitResponse added in v0.3.0 

func (x *ServerMessage) GetInitResponse() *InitResponse

func (*ServerMessage) GetTriggerRequest added in v0.3.0 

func (x *ServerMessage) GetTriggerRequest() *TriggerRequest

func (*ServerMessage) ProtoMessage added in v0.3.0 

func (*ServerMessage) ProtoMessage()

func (*ServerMessage) ProtoReflect added in v0.3.0 

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

func (*ServerMessage) Reset added in v0.3.0 

func (x *ServerMessage) Reset()

func (*ServerMessage) String added in v0.3.0 

func (x *ServerMessage) String() string

type ServerMessage_InitResponse added in v0.3.0 

type ServerMessage_InitResponse struct {
	// Server responding
	// with client configuration details to an
	// InitRequest
	InitResponse *InitResponse `protobuf:"bytes,2,opt,name=init_response,json=initResponse,proto3,oneof"`
}

type ServerMessage_TriggerRequest added in v0.3.0 

type ServerMessage_TriggerRequest struct {
	// Server requesting client to
	// process a trigger
	TriggerRequest *TriggerRequest `protobuf:"bytes,3,opt,name=trigger_request,json=triggerRequest,proto3,oneof"`
}

type StorageClient 

type StorageClient interface {
	// Retrieve an item from a bucket
	Read(ctx context.Context, in *StorageReadRequest, opts ...grpc.CallOption) (*StorageReadResponse, error)
	// Store an item to a bucket
	Write(ctx context.Context, in *StorageWriteRequest, opts ...grpc.CallOption) (*StorageWriteResponse, error)
	// Delete an item from a bucket
	Delete(ctx context.Context, in *StorageDeleteRequest, opts ...grpc.CallOption) (*StorageDeleteResponse, error)
}

StorageClient is the client API for Storage 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 NewStorageClient 

func NewStorageClient(cc grpc.ClientConnInterface) StorageClient

type StorageDeleteRequest 

type StorageDeleteRequest struct {

	// Name of the bucket to delete from
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Key of item to delete
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Request to delete a storage item

func (*StorageDeleteRequest) Descriptor deprecated 

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

Deprecated: Use StorageDeleteRequest.ProtoReflect.Descriptor instead.

func (*StorageDeleteRequest) GetBucketName 

func (x *StorageDeleteRequest) GetBucketName() string

func (*StorageDeleteRequest) GetKey 

func (x *StorageDeleteRequest) GetKey() string

func (*StorageDeleteRequest) ProtoMessage 

func (*StorageDeleteRequest) ProtoMessage()

func (*StorageDeleteRequest) ProtoReflect 

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

func (*StorageDeleteRequest) Reset 

func (x *StorageDeleteRequest) Reset()

func (*StorageDeleteRequest) String 

func (x *StorageDeleteRequest) String() string

type StorageDeleteResponse 

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

Result of deleting a storage item

func (*StorageDeleteResponse) Descriptor deprecated 

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

Deprecated: Use StorageDeleteResponse.ProtoReflect.Descriptor instead.

func (*StorageDeleteResponse) ProtoMessage 

func (*StorageDeleteResponse) ProtoMessage()

func (*StorageDeleteResponse) ProtoReflect 

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

func (*StorageDeleteResponse) Reset 

func (x *StorageDeleteResponse) Reset()

func (*StorageDeleteResponse) String 

func (x *StorageDeleteResponse) String() string

type StorageReadRequest 

type StorageReadRequest struct {

	// Nitric name of the bucket to retrieve from
	//  this will be automatically resolved to the provider specific bucket identifier.
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Key of item to retrieve
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Request to retrieve a storage item

func (*StorageReadRequest) Descriptor deprecated 

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

Deprecated: Use StorageReadRequest.ProtoReflect.Descriptor instead.

func (*StorageReadRequest) GetBucketName 

func (x *StorageReadRequest) GetBucketName() string

func (*StorageReadRequest) GetKey 

func (x *StorageReadRequest) GetKey() string

func (*StorageReadRequest) ProtoMessage 

func (*StorageReadRequest) ProtoMessage()

func (*StorageReadRequest) ProtoReflect 

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

func (*StorageReadRequest) Reset 

func (x *StorageReadRequest) Reset()

func (*StorageReadRequest) String 

func (x *StorageReadRequest) String() string

type StorageReadResponse 

type StorageReadResponse struct {

	// The body bytes of the retrieved storage item
	Body []byte `protobuf:"bytes,1,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

Returned storage item

func (*StorageReadResponse) Descriptor deprecated 

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

Deprecated: Use StorageReadResponse.ProtoReflect.Descriptor instead.

func (*StorageReadResponse) GetBody 

func (x *StorageReadResponse) GetBody() []byte

func (*StorageReadResponse) ProtoMessage 

func (*StorageReadResponse) ProtoMessage()

func (*StorageReadResponse) ProtoReflect 

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

func (*StorageReadResponse) Reset 

func (x *StorageReadResponse) Reset()

func (*StorageReadResponse) String 

func (x *StorageReadResponse) String() string

type StorageServer 

type StorageServer interface {
	// Retrieve an item from a bucket
	Read(context.Context, *StorageReadRequest) (*StorageReadResponse, error)
	// Store an item to a bucket
	Write(context.Context, *StorageWriteRequest) (*StorageWriteResponse, error)
	// Delete an item from a bucket
	Delete(context.Context, *StorageDeleteRequest) (*StorageDeleteResponse, error)
	// contains filtered or unexported methods
}

StorageServer is the server API for Storage service. All implementations must embed UnimplementedStorageServer for forward compatibility

type StorageWriteRequest 

type StorageWriteRequest struct {

	// Nitric name of the bucket to store in
	//  this will be automatically resolved to the provider specific bucket identifier.
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Key to store the item under
	Key string `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// bytes array to store
	Body []byte `protobuf:"bytes,3,opt,name=body,proto3" json:"body,omitempty"`
	// contains filtered or unexported fields
}

Request to put (create/update) a storage item

func (*StorageWriteRequest) Descriptor deprecated 

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

Deprecated: Use StorageWriteRequest.ProtoReflect.Descriptor instead.

func (*StorageWriteRequest) GetBody 

func (x *StorageWriteRequest) GetBody() []byte

func (*StorageWriteRequest) GetBucketName 

func (x *StorageWriteRequest) GetBucketName() string

func (*StorageWriteRequest) GetKey 

func (x *StorageWriteRequest) GetKey() string

func (*StorageWriteRequest) ProtoMessage 

func (*StorageWriteRequest) ProtoMessage()

func (*StorageWriteRequest) ProtoReflect 

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

func (*StorageWriteRequest) Reset 

func (x *StorageWriteRequest) Reset()

func (*StorageWriteRequest) String 

func (x *StorageWriteRequest) String() string

type StorageWriteResponse 

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

Result of putting a storage item

func (*StorageWriteResponse) Descriptor deprecated 

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

Deprecated: Use StorageWriteResponse.ProtoReflect.Descriptor instead.

func (*StorageWriteResponse) ProtoMessage 

func (*StorageWriteResponse) ProtoMessage()

func (*StorageWriteResponse) ProtoReflect 

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

func (*StorageWriteResponse) Reset 

func (x *StorageWriteResponse) Reset()

func (*StorageWriteResponse) String 

func (x *StorageWriteResponse) String() string

type TopicClient 

type TopicClient interface {
	// Return a list of existing topics in the provider environment
	List(ctx context.Context, in *TopicListRequest, opts ...grpc.CallOption) (*TopicListResponse, error)
}

TopicClient is the client API for Topic 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 NewTopicClient 

func NewTopicClient(cc grpc.ClientConnInterface) TopicClient

type TopicListRequest 

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

Request for the Topic List method

func (*TopicListRequest) Descriptor deprecated 

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

Deprecated: Use TopicListRequest.ProtoReflect.Descriptor instead.

func (*TopicListRequest) ProtoMessage 

func (*TopicListRequest) ProtoMessage()

func (*TopicListRequest) ProtoReflect 

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

func (*TopicListRequest) Reset 

func (x *TopicListRequest) Reset()

func (*TopicListRequest) String 

func (x *TopicListRequest) String() string

type TopicListResponse 

type TopicListResponse struct {

	// The list of found topics
	Topics []*NitricTopic `protobuf:"bytes,1,rep,name=topics,proto3" json:"topics,omitempty"`
	// contains filtered or unexported fields
}

Topic List Response

func (*TopicListResponse) Descriptor deprecated 

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

Deprecated: Use TopicListResponse.ProtoReflect.Descriptor instead.

func (*TopicListResponse) GetTopics 

func (x *TopicListResponse) GetTopics() []*NitricTopic

func (*TopicListResponse) ProtoMessage 

func (*TopicListResponse) ProtoMessage()

func (*TopicListResponse) ProtoReflect 

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

func (*TopicListResponse) Reset 

func (x *TopicListResponse) Reset()

func (*TopicListResponse) String 

func (x *TopicListResponse) String() string

type TopicResponseContext added in v0.3.0 

type TopicResponseContext struct {

	// Success status of the handled event
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

Specific event response message We do not accept responses for events only whether or not they were successfully processed

func (*TopicResponseContext) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use TopicResponseContext.ProtoReflect.Descriptor instead.

func (*TopicResponseContext) GetSuccess added in v0.3.0 

func (x *TopicResponseContext) GetSuccess() bool

func (*TopicResponseContext) ProtoMessage added in v0.3.0 

func (*TopicResponseContext) ProtoMessage()

func (*TopicResponseContext) ProtoReflect added in v0.3.0 

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

func (*TopicResponseContext) Reset added in v0.3.0 

func (x *TopicResponseContext) Reset()

func (*TopicResponseContext) String added in v0.3.0 

func (x *TopicResponseContext) String() string

type TopicServer 

type TopicServer interface {
	// Return a list of existing topics in the provider environment
	List(context.Context, *TopicListRequest) (*TopicListResponse, error)
	// contains filtered or unexported methods
}

TopicServer is the server API for Topic service. All implementations must embed UnimplementedTopicServer for forward compatibility

type TopicTriggerContext added in v0.3.0 

type TopicTriggerContext struct {

	// The topic the message was published for
	Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

func (*TopicTriggerContext) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use TopicTriggerContext.ProtoReflect.Descriptor instead.

func (*TopicTriggerContext) GetTopic added in v0.3.0 

func (x *TopicTriggerContext) GetTopic() string

func (*TopicTriggerContext) ProtoMessage added in v0.3.0 

func (*TopicTriggerContext) ProtoMessage()

func (*TopicTriggerContext) ProtoReflect added in v0.3.0 

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

func (*TopicTriggerContext) Reset added in v0.3.0 

func (x *TopicTriggerContext) Reset()

func (*TopicTriggerContext) String added in v0.3.0 

func (x *TopicTriggerContext) String() string

type TriggerRequest added in v0.3.0 

type TriggerRequest struct {

	// The data in the trigger
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// Should we supply a mime type for the data?
	// Or rely on context?
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// The context of the trigger
	//
	// Types that are assignable to Context:
	//	*TriggerRequest_Http
	//	*TriggerRequest_Topic
	Context isTriggerRequest_Context `protobuf_oneof:"context"`
	// contains filtered or unexported fields
}

The server has a trigger for the client to handle

func (*TriggerRequest) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use TriggerRequest.ProtoReflect.Descriptor instead.

func (*TriggerRequest) GetContext added in v0.3.0 

func (m *TriggerRequest) GetContext() isTriggerRequest_Context

func (*TriggerRequest) GetData added in v0.3.0 

func (x *TriggerRequest) GetData() []byte

func (*TriggerRequest) GetHttp added in v0.3.0 

func (x *TriggerRequest) GetHttp() *HttpTriggerContext

func (*TriggerRequest) GetMimeType added in v0.3.0 

func (x *TriggerRequest) GetMimeType() string

func (*TriggerRequest) GetTopic added in v0.3.0 

func (x *TriggerRequest) GetTopic() *TopicTriggerContext

func (*TriggerRequest) ProtoMessage added in v0.3.0 

func (*TriggerRequest) ProtoMessage()

func (*TriggerRequest) ProtoReflect added in v0.3.0 

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

func (*TriggerRequest) Reset added in v0.3.0 

func (x *TriggerRequest) Reset()

func (*TriggerRequest) String added in v0.3.0 

func (x *TriggerRequest) String() string

type TriggerRequest_Http added in v0.3.0 

type TriggerRequest_Http struct {
	Http *HttpTriggerContext `protobuf:"bytes,3,opt,name=http,proto3,oneof"`
}

type TriggerRequest_Topic added in v0.3.0 

type TriggerRequest_Topic struct {
	Topic *TopicTriggerContext `protobuf:"bytes,4,opt,name=topic,proto3,oneof"`
}

type TriggerResponse added in v0.3.0 

type TriggerResponse struct {

	// The data returned in the response
	Data []byte `protobuf:"bytes,1,opt,name=data,proto3" json:"data,omitempty"`
	// The context of the request response
	// Typically this will be one to one with the Trigger Context
	// i.e. if you receive http context you may return http context
	//
	// Types that are assignable to Context:
	//	*TriggerResponse_Http
	//	*TriggerResponse_Topic
	Context isTriggerResponse_Context `protobuf_oneof:"context"`
	// contains filtered or unexported fields
}

The worker has successfully processed a trigger

func (*TriggerResponse) Descriptor deprecated added in v0.3.0 

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

Deprecated: Use TriggerResponse.ProtoReflect.Descriptor instead.

func (*TriggerResponse) GetContext added in v0.3.0 

func (m *TriggerResponse) GetContext() isTriggerResponse_Context

func (*TriggerResponse) GetData added in v0.3.0 

func (x *TriggerResponse) GetData() []byte

func (*TriggerResponse) GetHttp added in v0.3.0 

func (x *TriggerResponse) GetHttp() *HttpResponseContext

func (*TriggerResponse) GetTopic added in v0.3.0 

func (x *TriggerResponse) GetTopic() *TopicResponseContext

func (*TriggerResponse) ProtoMessage added in v0.3.0 

func (*TriggerResponse) ProtoMessage()

func (*TriggerResponse) ProtoReflect added in v0.3.0 

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

func (*TriggerResponse) Reset added in v0.3.0 

func (x *TriggerResponse) Reset()

func (*TriggerResponse) String added in v0.3.0 

func (x *TriggerResponse) String() string

type TriggerResponse_Http added in v0.3.0 

type TriggerResponse_Http struct {
	// response to a http request
	Http *HttpResponseContext `protobuf:"bytes,10,opt,name=http,proto3,oneof"`
}

type TriggerResponse_Topic added in v0.3.0 

type TriggerResponse_Topic struct {
	// response to a topic trigger
	Topic *TopicResponseContext `protobuf:"bytes,11,opt,name=topic,proto3,oneof"`
}

type UnimplementedEventServer 

type UnimplementedEventServer struct {
}

UnimplementedEventServer must be embedded to have forward compatible implementations.

func (UnimplementedEventServer) Publish 

func (UnimplementedEventServer) Publish(context.Context, *EventPublishRequest) (*EventPublishResponse, error)

type UnimplementedFaasServer added in v0.3.0 

type UnimplementedFaasServer struct {
}

UnimplementedFaasServer must be embedded to have forward compatible implementations.

func (UnimplementedFaasServer) TriggerStream added in v0.3.0 

func (UnimplementedFaasServer) TriggerStream(Faas_TriggerStreamServer) error

type UnimplementedKeyValueServer 

type UnimplementedKeyValueServer struct {
}

UnimplementedKeyValueServer must be embedded to have forward compatible implementations.

func (UnimplementedKeyValueServer) Delete 

func (UnimplementedKeyValueServer) Delete(context.Context, *KeyValueDeleteRequest) (*KeyValueDeleteResponse, error)

func (UnimplementedKeyValueServer) Get 

func (UnimplementedKeyValueServer) Get(context.Context, *KeyValueGetRequest) (*KeyValueGetResponse, error)

func (UnimplementedKeyValueServer) Put 

func (UnimplementedKeyValueServer) Put(context.Context, *KeyValuePutRequest) (*KeyValuePutResponse, error)

type UnimplementedQueueServer 

type UnimplementedQueueServer struct {
}

UnimplementedQueueServer must be embedded to have forward compatible implementations.

func (UnimplementedQueueServer) Complete 

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

func (UnimplementedQueueServer) Receive 

func (UnimplementedQueueServer) Receive(context.Context, *QueueReceiveRequest) (*QueueReceiveResponse, error)

func (UnimplementedQueueServer) Send 

func (UnimplementedQueueServer) Send(context.Context, *QueueSendRequest) (*QueueSendResponse, error)

func (UnimplementedQueueServer) SendBatch 

func (UnimplementedQueueServer) SendBatch(context.Context, *QueueSendBatchRequest) (*QueueSendBatchResponse, error)

type UnimplementedStorageServer 

type UnimplementedStorageServer struct {
}

UnimplementedStorageServer must be embedded to have forward compatible implementations.

func (UnimplementedStorageServer) Delete 

func (UnimplementedStorageServer) Delete(context.Context, *StorageDeleteRequest) (*StorageDeleteResponse, error)

func (UnimplementedStorageServer) Read 

func (UnimplementedStorageServer) Read(context.Context, *StorageReadRequest) (*StorageReadResponse, error)

func (UnimplementedStorageServer) Write 

func (UnimplementedStorageServer) Write(context.Context, *StorageWriteRequest) (*StorageWriteResponse, error)

type UnimplementedTopicServer 

type UnimplementedTopicServer struct {
}

UnimplementedTopicServer must be embedded to have forward compatible implementations.

func (UnimplementedTopicServer) List 

func (UnimplementedTopicServer) List(context.Context, *TopicListRequest) (*TopicListResponse, error)

type UnsafeEventServer 

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

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

type UnsafeFaasServer added in v0.3.0 

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

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

type UnsafeKeyValueServer 

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

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

type UnsafeQueueServer 

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

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

type UnsafeStorageServer 

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

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

type UnsafeTopicServer 

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

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