v1

package
v0.15.1-rc.9 Latest Latest
Warning

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

 Go to latest Published: Mar 24, 2022 License: Apache-2.0, Apache-2.0 Imports: 10 Imported by: 6

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ResourceType_name = map[int32]string{
		0: "Api",
		1: "Function",
		2: "Bucket",
		3: "Queue",
		4: "Topic",
		5: "Schedule",
		6: "Subscription",
		7: "Collection",
		8: "Policy",
		9: "Secret",
	}
	ResourceType_value = map[string]int32{
		"Api":          0,
		"Function":     1,
		"Bucket":       2,
		"Queue":        3,
		"Topic":        4,
		"Schedule":     5,
		"Subscription": 6,
		"Collection":   7,
		"Policy":       8,
		"Secret":       9,
	}
)

Enum value maps for ResourceType.

View Source 
var (
	Action_name = map[int32]string{
		0:   "BucketFileList",
		1:   "BucketFileGet",
		2:   "BucketFilePut",
		3:   "BucketFileDelete",
		200: "TopicList",
		201: "TopicDetail",
		202: "TopicEventPublish",
		300: "QueueSend",
		301: "QueueReceive",
		302: "QueueList",
		303: "QueueDetail",
		400: "CollectionDocumentRead",
		401: "CollectionDocumentWrite",
		402: "CollectionDocumentDelete",
		403: "CollectionQuery",
		404: "CollectionList",
		500: "SecretPut",
		501: "SecretAccess",
	}
	Action_value = map[string]int32{
		"BucketFileList":           0,
		"BucketFileGet":            1,
		"BucketFilePut":            2,
		"BucketFileDelete":         3,
		"TopicList":                200,
		"TopicDetail":              201,
		"TopicEventPublish":        202,
		"QueueSend":                300,
		"QueueReceive":             301,
		"QueueList":                302,
		"QueueDetail":              303,
		"CollectionDocumentRead":   400,
		"CollectionDocumentWrite":  401,
		"CollectionDocumentDelete": 402,
		"CollectionQuery":          403,
		"CollectionList":           404,
		"SecretPut":                500,
		"SecretAccess":             501,
	}
)

Enum value maps for Action.

View Source 
var (
	StoragePreSignUrlRequest_Operation_name = map[int32]string{
		0: "READ",
		1: "WRITE",
	}
	StoragePreSignUrlRequest_Operation_value = map[string]int32{
		"READ":  0,
		"WRITE": 1,
	}
)

Enum value maps for StoragePreSignUrlRequest_Operation.

View Source 
var DocumentService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.document.v1.DocumentService",
	HandlerType: (*DocumentServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Get",
			Handler:    _DocumentService_Get_Handler,
		},
		{
			MethodName: "Set",
			Handler:    _DocumentService_Set_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _DocumentService_Delete_Handler,
		},
		{
			MethodName: "Query",
			Handler:    _DocumentService_Query_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "QueryStream",
			Handler:       _DocumentService_QueryStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "proto/document/v1/document.proto",
}

DocumentService_ServiceDesc is the grpc.ServiceDesc for DocumentService 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 EventService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.event.v1.EventService",
	HandlerType: (*EventServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Publish",
			Handler:    _EventService_Publish_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/event/v1/event.proto",
}

EventService_ServiceDesc is the grpc.ServiceDesc for EventService 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 FaasService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.faas.v1.FaasService",
	HandlerType: (*FaasServiceServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "TriggerStream",
			Handler:       _FaasService_TriggerStream_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "proto/faas/v1/faas.proto",
}

FaasService_ServiceDesc is the grpc.ServiceDesc for FaasService 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_proto_document_v1_document_proto protoreflect.FileDescriptor
View Source 
var File_proto_error_v1_error_proto protoreflect.FileDescriptor
View Source 
var File_proto_event_v1_event_proto protoreflect.FileDescriptor
View Source 
var File_proto_faas_v1_faas_proto protoreflect.FileDescriptor
View Source 
var File_proto_queue_v1_queue_proto protoreflect.FileDescriptor
View Source 
var File_proto_resource_v1_resource_proto protoreflect.FileDescriptor
View Source 
var File_proto_secret_v1_secret_proto protoreflect.FileDescriptor
View Source 
var File_proto_storage_v1_storage_proto protoreflect.FileDescriptor
View Source 
var QueueService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.queue.v1.QueueService",
	HandlerType: (*QueueServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Send",
			Handler:    _QueueService_Send_Handler,
		},
		{
			MethodName: "SendBatch",
			Handler:    _QueueService_SendBatch_Handler,
		},
		{
			MethodName: "Receive",
			Handler:    _QueueService_Receive_Handler,
		},
		{
			MethodName: "Complete",
			Handler:    _QueueService_Complete_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/queue/v1/queue.proto",
}

QueueService_ServiceDesc is the grpc.ServiceDesc for QueueService 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 ResourceService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.resource.v1.ResourceService",
	HandlerType: (*ResourceServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Declare",
			Handler:    _ResourceService_Declare_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/resource/v1/resource.proto",
}

ResourceService_ServiceDesc is the grpc.ServiceDesc for ResourceService 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 SecretService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.secret.v1.SecretService",
	HandlerType: (*SecretServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Put",
			Handler:    _SecretService_Put_Handler,
		},
		{
			MethodName: "Access",
			Handler:    _SecretService_Access_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/secret/v1/secret.proto",
}

SecretService_ServiceDesc is the grpc.ServiceDesc for SecretService 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 StorageService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.storage.v1.StorageService",
	HandlerType: (*StorageServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _StorageService_Read_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _StorageService_Write_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _StorageService_Delete_Handler,
		},
		{
			MethodName: "PreSignUrl",
			Handler:    _StorageService_PreSignUrl_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/storage/v1/storage.proto",
}

StorageService_ServiceDesc is the grpc.ServiceDesc for StorageService 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 TopicService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.event.v1.TopicService",
	HandlerType: (*TopicServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "List",
			Handler:    _TopicService_List_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/event/v1/event.proto",
}

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

Functions

func RegisterDocumentServiceServer 

func RegisterDocumentServiceServer(s grpc.ServiceRegistrar, srv DocumentServiceServer)

func RegisterEventServiceServer 

func RegisterEventServiceServer(s grpc.ServiceRegistrar, srv EventServiceServer)

func RegisterFaasServiceServer 

func RegisterFaasServiceServer(s grpc.ServiceRegistrar, srv FaasServiceServer)

func RegisterQueueServiceServer 

func RegisterQueueServiceServer(s grpc.ServiceRegistrar, srv QueueServiceServer)

func RegisterResourceServiceServer added in v0.13.0 

func RegisterResourceServiceServer(s grpc.ServiceRegistrar, srv ResourceServiceServer)

func RegisterSecretServiceServer 

func RegisterSecretServiceServer(s grpc.ServiceRegistrar, srv SecretServiceServer)

func RegisterStorageServiceServer 

func RegisterStorageServiceServer(s grpc.ServiceRegistrar, srv StorageServiceServer)

func RegisterTopicServiceServer 

func RegisterTopicServiceServer(s grpc.ServiceRegistrar, srv TopicServiceServer)

Types

type Action added in v0.13.0 

type Action int32
const (
	// Bucket Permissions: 0XX
	Action_BucketFileList   Action = 0
	Action_BucketFileGet    Action = 1
	Action_BucketFilePut    Action = 2
	Action_BucketFileDelete Action = 3
	// Topic Permissions: 2XX
	Action_TopicList         Action = 200
	Action_TopicDetail       Action = 201
	Action_TopicEventPublish Action = 202
	// Queue Permissions: 3XX
	Action_QueueSend    Action = 300
	Action_QueueReceive Action = 301
	Action_QueueList    Action = 302
	Action_QueueDetail  Action = 303
	// Collection Permissions: 4XX
	Action_CollectionDocumentRead   Action = 400
	Action_CollectionDocumentWrite  Action = 401
	Action_CollectionDocumentDelete Action = 402
	Action_CollectionQuery          Action = 403
	Action_CollectionList           Action = 404
	// Secret Permissions: 5XX
	Action_SecretPut    Action = 500
	Action_SecretAccess Action = 501
)

func (Action) Descriptor added in v0.13.0 

func (Action) Descriptor() protoreflect.EnumDescriptor

func (Action) Enum added in v0.13.0 

func (x Action) Enum() *Action

func (Action) EnumDescriptor deprecated added in v0.13.0 

func (Action) EnumDescriptor() ([]byte, []int)

Deprecated: Use Action.Descriptor instead.

func (Action) Number added in v0.13.0 

func (x Action) Number() protoreflect.EnumNumber

func (Action) String added in v0.13.0 

func (x Action) String() string

func (Action) Type added in v0.13.0 

func (Action) Type() protoreflect.EnumType

type ApiWorker added in v0.13.0 

type ApiWorker struct {
	Api     string   `protobuf:"bytes,1,opt,name=api,proto3" json:"api,omitempty"`
	Path    string   `protobuf:"bytes,2,opt,name=path,proto3" json:"path,omitempty"`
	Methods []string `protobuf:"bytes,3,rep,name=methods,proto3" json:"methods,omitempty"`
	// contains filtered or unexported fields
}

func (*ApiWorker) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ApiWorker.ProtoReflect.Descriptor instead.

func (*ApiWorker) GetApi added in v0.13.0 

func (x *ApiWorker) GetApi() string

func (*ApiWorker) GetMethods added in v0.13.0 

func (x *ApiWorker) GetMethods() []string

func (*ApiWorker) GetPath added in v0.13.0 

func (x *ApiWorker) GetPath() string

func (*ApiWorker) ProtoMessage added in v0.13.0 

func (*ApiWorker) ProtoMessage()

func (*ApiWorker) ProtoReflect added in v0.13.0 

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

func (*ApiWorker) Reset added in v0.13.0 

func (x *ApiWorker) Reset()

func (*ApiWorker) String added in v0.13.0 

func (x *ApiWorker) String() string

type BucketResource added in v0.13.0 

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

func (*BucketResource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use BucketResource.ProtoReflect.Descriptor instead.

func (*BucketResource) ProtoMessage added in v0.13.0 

func (*BucketResource) ProtoMessage()

func (*BucketResource) ProtoReflect added in v0.13.0 

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

func (*BucketResource) Reset added in v0.13.0 

func (x *BucketResource) Reset()

func (*BucketResource) String added in v0.13.0 

func (x *BucketResource) String() string

type ClientMessage 

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 

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

Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.

func (*ClientMessage) GetContent 

func (m *ClientMessage) GetContent() isClientMessage_Content

func (*ClientMessage) GetId 

func (x *ClientMessage) GetId() string

func (*ClientMessage) GetInitRequest 

func (x *ClientMessage) GetInitRequest() *InitRequest

func (*ClientMessage) GetTriggerResponse 

func (x *ClientMessage) GetTriggerResponse() *TriggerResponse

func (*ClientMessage) ProtoMessage 

func (*ClientMessage) ProtoMessage()

func (*ClientMessage) ProtoReflect 

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

func (*ClientMessage) Reset 

func (x *ClientMessage) Reset()

func (*ClientMessage) String 

func (x *ClientMessage) String() string

type ClientMessage_InitRequest 

type ClientMessage_InitRequest struct {
	// Client initialisation request
	// A worker will not be eligible for triggers
	// until it has identified itself
	InitRequest *InitRequest `protobuf:"bytes,2,opt,name=init_request,json=initRequest,proto3,oneof"`
}

type ClientMessage_TriggerResponse 

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 Collection 

type Collection struct {

	// The collection name
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// Optional parent key, required when the collection is a sub-collection of another document
	Parent *Key `protobuf:"bytes,2,opt,name=parent,proto3" json:"parent,omitempty"`
	// contains filtered or unexported fields
}

Provides a Collection type for storing documents

func (*Collection) Descriptor deprecated 

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

Deprecated: Use Collection.ProtoReflect.Descriptor instead.

func (*Collection) GetName 

func (x *Collection) GetName() string

func (*Collection) GetParent 

func (x *Collection) GetParent() *Key

func (*Collection) ProtoMessage 

func (*Collection) ProtoMessage()

func (*Collection) ProtoReflect 

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

func (*Collection) Reset 

func (x *Collection) Reset()

func (*Collection) String 

func (x *Collection) String() string

type CollectionResource added in v0.13.0 

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

func (*CollectionResource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use CollectionResource.ProtoReflect.Descriptor instead.

func (*CollectionResource) ProtoMessage added in v0.13.0 

func (*CollectionResource) ProtoMessage()

func (*CollectionResource) ProtoReflect added in v0.13.0 

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

func (*CollectionResource) Reset added in v0.13.0 

func (x *CollectionResource) Reset()

func (*CollectionResource) String added in v0.13.0 

func (x *CollectionResource) String() string

type Document 

type Document struct {

	// The document content (JSON object)
	Content *structpb.Struct `protobuf:"bytes,1,opt,name=content,proto3" json:"content,omitempty"`
	// The document's unique key, including collection/sub-collections
	Key *Key `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

Provides a return document type

func (*Document) Descriptor deprecated 

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

Deprecated: Use Document.ProtoReflect.Descriptor instead.

func (*Document) GetContent 

func (x *Document) GetContent() *structpb.Struct

func (*Document) GetKey 

func (x *Document) GetKey() *Key

func (*Document) ProtoMessage 

func (*Document) ProtoMessage()

func (*Document) ProtoReflect 

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

func (*Document) Reset 

func (x *Document) Reset()

func (*Document) String 

func (x *Document) String() string

type DocumentDeleteRequest 

type DocumentDeleteRequest struct {

	// Key of the document to delete
	Key *Key `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentDeleteRequest) Descriptor deprecated 

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

Deprecated: Use DocumentDeleteRequest.ProtoReflect.Descriptor instead.

func (*DocumentDeleteRequest) GetKey 

func (x *DocumentDeleteRequest) GetKey() *Key

func (*DocumentDeleteRequest) ProtoMessage 

func (*DocumentDeleteRequest) ProtoMessage()

func (*DocumentDeleteRequest) ProtoReflect 

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

func (*DocumentDeleteRequest) Reset 

func (x *DocumentDeleteRequest) Reset()

func (*DocumentDeleteRequest) String 

func (x *DocumentDeleteRequest) String() string

type DocumentDeleteResponse 

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

func (*DocumentDeleteResponse) Descriptor deprecated 

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

Deprecated: Use DocumentDeleteResponse.ProtoReflect.Descriptor instead.

func (*DocumentDeleteResponse) ProtoMessage 

func (*DocumentDeleteResponse) ProtoMessage()

func (*DocumentDeleteResponse) ProtoReflect 

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

func (*DocumentDeleteResponse) Reset 

func (x *DocumentDeleteResponse) Reset()

func (*DocumentDeleteResponse) String 

func (x *DocumentDeleteResponse) String() string

type DocumentGetRequest 

type DocumentGetRequest struct {

	// Key of the document to retrieve
	Key *Key `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentGetRequest) Descriptor deprecated 

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

Deprecated: Use DocumentGetRequest.ProtoReflect.Descriptor instead.

func (*DocumentGetRequest) GetKey 

func (x *DocumentGetRequest) GetKey() *Key

func (*DocumentGetRequest) ProtoMessage 

func (*DocumentGetRequest) ProtoMessage()

func (*DocumentGetRequest) ProtoReflect 

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

func (*DocumentGetRequest) Reset 

func (x *DocumentGetRequest) Reset()

func (*DocumentGetRequest) String 

func (x *DocumentGetRequest) String() string

type DocumentGetResponse 

type DocumentGetResponse struct {

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

func (*DocumentGetResponse) Descriptor deprecated 

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

Deprecated: Use DocumentGetResponse.ProtoReflect.Descriptor instead.

func (*DocumentGetResponse) GetDocument 

func (x *DocumentGetResponse) GetDocument() *Document

func (*DocumentGetResponse) ProtoMessage 

func (*DocumentGetResponse) ProtoMessage()

func (*DocumentGetResponse) ProtoReflect 

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

func (*DocumentGetResponse) Reset 

func (x *DocumentGetResponse) Reset()

func (*DocumentGetResponse) String 

func (x *DocumentGetResponse) String() string

type DocumentQueryRequest 

type DocumentQueryRequest struct {

	// The collection to query
	Collection *Collection `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Optional query expressions
	Expressions []*Expression `protobuf:"bytes,3,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// Optional query fetch limit
	Limit int32 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// Optional query paging continuation token
	PagingToken map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DocumentQueryRequest) Descriptor deprecated 

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

Deprecated: Use DocumentQueryRequest.ProtoReflect.Descriptor instead.

func (*DocumentQueryRequest) GetCollection 

func (x *DocumentQueryRequest) GetCollection() *Collection

func (*DocumentQueryRequest) GetExpressions 

func (x *DocumentQueryRequest) GetExpressions() []*Expression

func (*DocumentQueryRequest) GetLimit 

func (x *DocumentQueryRequest) GetLimit() int32

func (*DocumentQueryRequest) GetPagingToken 

func (x *DocumentQueryRequest) GetPagingToken() map[string]string

func (*DocumentQueryRequest) ProtoMessage 

func (*DocumentQueryRequest) ProtoMessage()

func (*DocumentQueryRequest) ProtoReflect 

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

func (*DocumentQueryRequest) Reset 

func (x *DocumentQueryRequest) Reset()

func (*DocumentQueryRequest) String 

func (x *DocumentQueryRequest) String() string

type DocumentQueryResponse 

type DocumentQueryResponse struct {

	// The retrieved values
	Documents []*Document `protobuf:"bytes,1,rep,name=documents,proto3" json:"documents,omitempty"`
	// The query paging continuation token, when empty no further results are available
	PagingToken map[string]string `` /* 182-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*DocumentQueryResponse) Descriptor deprecated 

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

Deprecated: Use DocumentQueryResponse.ProtoReflect.Descriptor instead.

func (*DocumentQueryResponse) GetDocuments 

func (x *DocumentQueryResponse) GetDocuments() []*Document

func (*DocumentQueryResponse) GetPagingToken 

func (x *DocumentQueryResponse) GetPagingToken() map[string]string

func (*DocumentQueryResponse) ProtoMessage 

func (*DocumentQueryResponse) ProtoMessage()

func (*DocumentQueryResponse) ProtoReflect 

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

func (*DocumentQueryResponse) Reset 

func (x *DocumentQueryResponse) Reset()

func (*DocumentQueryResponse) String 

func (x *DocumentQueryResponse) String() string

type DocumentQueryStreamRequest 

type DocumentQueryStreamRequest struct {

	// The collection to query
	Collection *Collection `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// Optional query expressions
	Expressions []*Expression `protobuf:"bytes,3,rep,name=expressions,proto3" json:"expressions,omitempty"`
	// Optional query fetch limit
	Limit int32 `protobuf:"varint,4,opt,name=limit,proto3" json:"limit,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentQueryStreamRequest) Descriptor deprecated 

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

Deprecated: Use DocumentQueryStreamRequest.ProtoReflect.Descriptor instead.

func (*DocumentQueryStreamRequest) GetCollection 

func (x *DocumentQueryStreamRequest) GetCollection() *Collection

func (*DocumentQueryStreamRequest) GetExpressions 

func (x *DocumentQueryStreamRequest) GetExpressions() []*Expression

func (*DocumentQueryStreamRequest) GetLimit 

func (x *DocumentQueryStreamRequest) GetLimit() int32

func (*DocumentQueryStreamRequest) ProtoMessage 

func (*DocumentQueryStreamRequest) ProtoMessage()

func (*DocumentQueryStreamRequest) ProtoReflect 

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

func (*DocumentQueryStreamRequest) Reset 

func (x *DocumentQueryStreamRequest) Reset()

func (*DocumentQueryStreamRequest) String 

func (x *DocumentQueryStreamRequest) String() string

type DocumentQueryStreamResponse 

type DocumentQueryStreamResponse struct {

	// The stream document
	Document *Document `protobuf:"bytes,1,opt,name=document,proto3" json:"document,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentQueryStreamResponse) Descriptor deprecated 

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

Deprecated: Use DocumentQueryStreamResponse.ProtoReflect.Descriptor instead.

func (*DocumentQueryStreamResponse) GetDocument 

func (x *DocumentQueryStreamResponse) GetDocument() *Document

func (*DocumentQueryStreamResponse) ProtoMessage 

func (*DocumentQueryStreamResponse) ProtoMessage()

func (*DocumentQueryStreamResponse) ProtoReflect 

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

func (*DocumentQueryStreamResponse) Reset 

func (x *DocumentQueryStreamResponse) Reset()

func (*DocumentQueryStreamResponse) String 

func (x *DocumentQueryStreamResponse) String() string

type DocumentServiceClient 

type DocumentServiceClient interface {
	// Get an existing document
	Get(ctx context.Context, in *DocumentGetRequest, opts ...grpc.CallOption) (*DocumentGetResponse, error)
	// Create a new or overwrite an existing document
	Set(ctx context.Context, in *DocumentSetRequest, opts ...grpc.CallOption) (*DocumentSetResponse, error)
	// Delete an existing document
	Delete(ctx context.Context, in *DocumentDeleteRequest, opts ...grpc.CallOption) (*DocumentDeleteResponse, error)
	// Query the document collection (supports pagination)
	Query(ctx context.Context, in *DocumentQueryRequest, opts ...grpc.CallOption) (*DocumentQueryResponse, error)
	// Query the document collection (supports streaming)
	QueryStream(ctx context.Context, in *DocumentQueryStreamRequest, opts ...grpc.CallOption) (DocumentService_QueryStreamClient, error)
}

DocumentServiceClient is the client API for DocumentService 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 NewDocumentServiceClient 

func NewDocumentServiceClient(cc grpc.ClientConnInterface) DocumentServiceClient

type DocumentServiceServer 

type DocumentServiceServer interface {
	// Get an existing document
	Get(context.Context, *DocumentGetRequest) (*DocumentGetResponse, error)
	// Create a new or overwrite an existing document
	Set(context.Context, *DocumentSetRequest) (*DocumentSetResponse, error)
	// Delete an existing document
	Delete(context.Context, *DocumentDeleteRequest) (*DocumentDeleteResponse, error)
	// Query the document collection (supports pagination)
	Query(context.Context, *DocumentQueryRequest) (*DocumentQueryResponse, error)
	// Query the document collection (supports streaming)
	QueryStream(*DocumentQueryStreamRequest, DocumentService_QueryStreamServer) error
}

DocumentServiceServer is the server API for DocumentService service. All implementations should embed UnimplementedDocumentServiceServer for forward compatibility

type DocumentService_QueryStreamClient 

type DocumentService_QueryStreamClient interface {
	Recv() (*DocumentQueryStreamResponse, error)
	grpc.ClientStream
}

type DocumentService_QueryStreamServer 

type DocumentService_QueryStreamServer interface {
	Send(*DocumentQueryStreamResponse) error
	grpc.ServerStream
}

type DocumentSetRequest 

type DocumentSetRequest struct {

	// Key of the document to set
	Key *Key `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The document content to store (JSON object)
	Content *structpb.Struct `protobuf:"bytes,3,opt,name=content,proto3" json:"content,omitempty"`
	// contains filtered or unexported fields
}

func (*DocumentSetRequest) Descriptor deprecated 

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

Deprecated: Use DocumentSetRequest.ProtoReflect.Descriptor instead.

func (*DocumentSetRequest) GetContent 

func (x *DocumentSetRequest) GetContent() *structpb.Struct

func (*DocumentSetRequest) GetKey 

func (x *DocumentSetRequest) GetKey() *Key

func (*DocumentSetRequest) ProtoMessage 

func (*DocumentSetRequest) ProtoMessage()

func (*DocumentSetRequest) ProtoReflect 

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

func (*DocumentSetRequest) Reset 

func (x *DocumentSetRequest) Reset()

func (*DocumentSetRequest) String 

func (x *DocumentSetRequest) String() string

type DocumentSetResponse 

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

func (*DocumentSetResponse) Descriptor deprecated 

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

Deprecated: Use DocumentSetResponse.ProtoReflect.Descriptor instead.

func (*DocumentSetResponse) ProtoMessage 

func (*DocumentSetResponse) ProtoMessage()

func (*DocumentSetResponse) ProtoReflect 

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

func (*DocumentSetResponse) Reset 

func (x *DocumentSetResponse) Reset()

func (*DocumentSetResponse) String 

func (x *DocumentSetResponse) String() string

type ErrorDetails 

type ErrorDetails struct {

	// The developer error message, explaining the error and ideally solution.
	Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
	// The error root cause.
	Cause string `protobuf:"bytes,2,opt,name=cause,proto3" json:"cause,omitempty"`
	// The scope of the error.
	Scope *ErrorScope `protobuf:"bytes,3,opt,name=scope,proto3" json:"scope,omitempty"`
	// contains filtered or unexported fields
}

func (*ErrorDetails) Descriptor deprecated 

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

Deprecated: Use ErrorDetails.ProtoReflect.Descriptor instead.

func (*ErrorDetails) GetCause 

func (x *ErrorDetails) GetCause() string

func (*ErrorDetails) GetMessage 

func (x *ErrorDetails) GetMessage() string

func (*ErrorDetails) GetScope 

func (x *ErrorDetails) GetScope() *ErrorScope

func (*ErrorDetails) ProtoMessage 

func (*ErrorDetails) ProtoMessage()

func (*ErrorDetails) ProtoReflect 

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

func (*ErrorDetails) Reset 

func (x *ErrorDetails) Reset()

func (*ErrorDetails) String 

func (x *ErrorDetails) String() string

type ErrorScope 

type ErrorScope struct {

	// The API service invoked, e.g. 'Service.Method'.
	Service string `protobuf:"bytes,1,opt,name=service,proto3" json:"service,omitempty"`
	// The plugin method invoked, e.g. 'PluginService.Method'.
	Plugin string `protobuf:"bytes,2,opt,name=plugin,proto3" json:"plugin,omitempty"`
	// The plugin method arguments, ensure only non-sensitive data is specified.
	Args map[string]string `` /* 149-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ErrorScope) Descriptor deprecated 

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

Deprecated: Use ErrorScope.ProtoReflect.Descriptor instead.

func (*ErrorScope) GetArgs 

func (x *ErrorScope) GetArgs() map[string]string

func (*ErrorScope) GetPlugin 

func (x *ErrorScope) GetPlugin() string

func (*ErrorScope) GetService 

func (x *ErrorScope) GetService() string

func (*ErrorScope) ProtoMessage 

func (*ErrorScope) ProtoMessage()

func (*ErrorScope) ProtoReflect 

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

func (*ErrorScope) Reset 

func (x *ErrorScope) Reset()

func (*ErrorScope) String 

func (x *ErrorScope) String() string

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 EventServiceClient 

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

EventServiceClient is the client API for EventService 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 NewEventServiceClient 

func NewEventServiceClient(cc grpc.ClientConnInterface) EventServiceClient

type EventServiceServer 

type EventServiceServer interface {
	// Publishes an message to a given topic
	Publish(context.Context, *EventPublishRequest) (*EventPublishResponse, error)
}

EventServiceServer is the server API for EventService service. All implementations should embed UnimplementedEventServiceServer for forward compatibility

type Expression 

type Expression struct {

	// The query operand or attribute
	Operand string `protobuf:"bytes,1,opt,name=operand,proto3" json:"operand,omitempty"`
	// The query operator [ == | < | <= | > | >= | startsWith ]
	Operator string `protobuf:"bytes,2,opt,name=operator,proto3" json:"operator,omitempty"`
	// The query expression value
	Value *ExpressionValue `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Provides a query expression type

func (*Expression) Descriptor deprecated 

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

Deprecated: Use Expression.ProtoReflect.Descriptor instead.

func (*Expression) GetOperand 

func (x *Expression) GetOperand() string

func (*Expression) GetOperator 

func (x *Expression) GetOperator() string

func (*Expression) GetValue 

func (x *Expression) GetValue() *ExpressionValue

func (*Expression) ProtoMessage 

func (*Expression) ProtoMessage()

func (*Expression) ProtoReflect 

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

func (*Expression) Reset 

func (x *Expression) Reset()

func (*Expression) String 

func (x *Expression) String() string

type ExpressionValue 

type ExpressionValue struct {

	// The kind of value.
	//
	// Types that are assignable to Kind:
	//	*ExpressionValue_IntValue
	//	*ExpressionValue_DoubleValue
	//	*ExpressionValue_StringValue
	//	*ExpressionValue_BoolValue
	Kind isExpressionValue_Kind `protobuf_oneof:"kind"`
	// contains filtered or unexported fields
}

func (*ExpressionValue) Descriptor deprecated 

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

Deprecated: Use ExpressionValue.ProtoReflect.Descriptor instead.

func (*ExpressionValue) GetBoolValue 

func (x *ExpressionValue) GetBoolValue() bool

func (*ExpressionValue) GetDoubleValue 

func (x *ExpressionValue) GetDoubleValue() float64

func (*ExpressionValue) GetIntValue 

func (x *ExpressionValue) GetIntValue() int64

func (*ExpressionValue) GetKind 

func (m *ExpressionValue) GetKind() isExpressionValue_Kind

func (*ExpressionValue) GetStringValue 

func (x *ExpressionValue) GetStringValue() string

func (*ExpressionValue) ProtoMessage 

func (*ExpressionValue) ProtoMessage()

func (*ExpressionValue) ProtoReflect 

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

func (*ExpressionValue) Reset 

func (x *ExpressionValue) Reset()

func (*ExpressionValue) String 

func (x *ExpressionValue) String() string

type ExpressionValue_BoolValue 

type ExpressionValue_BoolValue struct {
	// Represents a boolean value.
	BoolValue bool `protobuf:"varint,4,opt,name=bool_value,json=boolValue,proto3,oneof"`
}

type ExpressionValue_DoubleValue 

type ExpressionValue_DoubleValue struct {
	// Represents a double value.
	DoubleValue float64 `protobuf:"fixed64,2,opt,name=double_value,json=doubleValue,proto3,oneof"`
}

type ExpressionValue_IntValue 

type ExpressionValue_IntValue struct {
	// Represents an integer value.
	IntValue int64 `protobuf:"varint,1,opt,name=int_value,json=intValue,proto3,oneof"`
}

type ExpressionValue_StringValue 

type ExpressionValue_StringValue struct {
	// Represents a string value.
	StringValue string `protobuf:"bytes,3,opt,name=string_value,json=stringValue,proto3,oneof"`
}

type FaasServiceClient 

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

FaasServiceClient is the client API for FaasService 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 NewFaasServiceClient 

func NewFaasServiceClient(cc grpc.ClientConnInterface) FaasServiceClient

type FaasServiceServer 

type FaasServiceServer interface {
	// Begin streaming triggers/response to/from the membrane
	TriggerStream(FaasService_TriggerStreamServer) error
}

FaasServiceServer is the server API for FaasService service. All implementations should embed UnimplementedFaasServiceServer for forward compatibility

type FaasService_TriggerStreamClient 

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

type FaasService_TriggerStreamServer 

type FaasService_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 HeaderValue 

type HeaderValue struct {
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*HeaderValue) Descriptor deprecated 

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

Deprecated: Use HeaderValue.ProtoReflect.Descriptor instead.

func (*HeaderValue) GetValue 

func (x *HeaderValue) GetValue() []string

func (*HeaderValue) ProtoMessage 

func (*HeaderValue) ProtoMessage()

func (*HeaderValue) ProtoReflect 

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

func (*HeaderValue) Reset 

func (x *HeaderValue) Reset()

func (*HeaderValue) String 

func (x *HeaderValue) String() string

type HttpResponseContext 

type HttpResponseContext struct {

	// Old HTTP response headers (deprecated)
	// TODO: Remove in 1.0
	//
	// Deprecated: Do not use.
	HeadersOld map[string]string `` /* 179-byte string literal not displayed */
	// The HTTP status of the request
	Status int32 `protobuf:"varint,2,opt,name=status,proto3" json:"status,omitempty"`
	// HTTP response headers
	Headers map[string]*HeaderValue `` /* 155-byte string literal not displayed */
	// 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 

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

Deprecated: Use HttpResponseContext.ProtoReflect.Descriptor instead.

func (*HttpResponseContext) GetHeaders 

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

func (*HttpResponseContext) GetHeadersOld deprecated 

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

Deprecated: Do not use.

func (*HttpResponseContext) GetStatus 

func (x *HttpResponseContext) GetStatus() int32

func (*HttpResponseContext) ProtoMessage 

func (*HttpResponseContext) ProtoMessage()

func (*HttpResponseContext) ProtoReflect 

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

func (*HttpResponseContext) Reset 

func (x *HttpResponseContext) Reset()

func (*HttpResponseContext) String 

func (x *HttpResponseContext) String() string

type HttpTriggerContext 

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 old request headers (preserving for backwards compatibility)
	// TODO: Remove in 1.0
	//
	// Deprecated: Do not use.
	HeadersOld map[string]string `` /* 179-byte string literal not displayed */
	// The old query params (preserving for backwards compatibility)
	// TODO: Remove in 1.0
	//
	// Deprecated: Do not use.
	QueryParamsOld map[string]string `` /* 193-byte string literal not displayed */
	// HTTP request headers
	Headers map[string]*HeaderValue `` /* 155-byte string literal not displayed */
	// HTTP Query params
	QueryParams map[string]*QueryValue `` /* 182-byte string literal not displayed */
	// HTTP Path parameters
	PathParams map[string]string `` /* 179-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*HttpTriggerContext) Descriptor deprecated 

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

Deprecated: Use HttpTriggerContext.ProtoReflect.Descriptor instead.

func (*HttpTriggerContext) GetHeaders 

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

func (*HttpTriggerContext) GetHeadersOld deprecated 

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

Deprecated: Do not use.

func (*HttpTriggerContext) GetMethod 

func (x *HttpTriggerContext) GetMethod() string

func (*HttpTriggerContext) GetPath 

func (x *HttpTriggerContext) GetPath() string

func (*HttpTriggerContext) GetPathParams added in v0.13.0 

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

func (*HttpTriggerContext) GetQueryParams 

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

func (*HttpTriggerContext) GetQueryParamsOld deprecated 

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

Deprecated: Do not use.

func (*HttpTriggerContext) ProtoMessage 

func (*HttpTriggerContext) ProtoMessage()

func (*HttpTriggerContext) ProtoReflect 

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

func (*HttpTriggerContext) Reset 

func (x *HttpTriggerContext) Reset()

func (*HttpTriggerContext) String 

func (x *HttpTriggerContext) String() string

type InitRequest 

type InitRequest struct {

	// The type of worker we are registering
	//
	// Types that are assignable to Worker:
	//	*InitRequest_Api
	//	*InitRequest_Subscription
	//	*InitRequest_Schedule
	Worker isInitRequest_Worker `protobuf_oneof:"Worker"`
	// contains filtered or unexported fields
}

InitRequest - Identifies a worker as ready to recieve triggers This message will contain information on the type of triggers that a worker is capable of handling

func (*InitRequest) Descriptor deprecated 

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

Deprecated: Use InitRequest.ProtoReflect.Descriptor instead.

func (*InitRequest) GetApi added in v0.13.0 

func (x *InitRequest) GetApi() *ApiWorker

func (*InitRequest) GetSchedule added in v0.13.0 

func (x *InitRequest) GetSchedule() *ScheduleWorker

func (*InitRequest) GetSubscription added in v0.13.0 

func (x *InitRequest) GetSubscription() *SubscriptionWorker

func (*InitRequest) GetWorker added in v0.13.0 

func (m *InitRequest) GetWorker() isInitRequest_Worker

func (*InitRequest) ProtoMessage 

func (*InitRequest) ProtoMessage()

func (*InitRequest) ProtoReflect 

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

func (*InitRequest) Reset 

func (x *InitRequest) Reset()

func (*InitRequest) String 

func (x *InitRequest) String() string

type InitRequest_Api added in v0.13.0 

type InitRequest_Api struct {
	Api *ApiWorker `protobuf:"bytes,10,opt,name=api,proto3,oneof"`
}

type InitRequest_Schedule added in v0.13.0 

type InitRequest_Schedule struct {
	Schedule *ScheduleWorker `protobuf:"bytes,12,opt,name=schedule,proto3,oneof"`
}

type InitRequest_Subscription added in v0.13.0 

type InitRequest_Subscription struct {
	Subscription *SubscriptionWorker `protobuf:"bytes,11,opt,name=subscription,proto3,oneof"`
}

type InitResponse 

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

Placeholder message

func (*InitResponse) Descriptor deprecated 

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

Deprecated: Use InitResponse.ProtoReflect.Descriptor instead.

func (*InitResponse) ProtoMessage 

func (*InitResponse) ProtoMessage()

func (*InitResponse) ProtoReflect 

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

func (*InitResponse) Reset 

func (x *InitResponse) Reset()

func (*InitResponse) String 

func (x *InitResponse) String() string

type Key 

type Key struct {

	// The item collection
	Collection *Collection `protobuf:"bytes,1,opt,name=collection,proto3" json:"collection,omitempty"`
	// The items unique id
	Id string `protobuf:"bytes,2,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

Provides a document identifying key type

func (*Key) Descriptor deprecated 

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

Deprecated: Use Key.ProtoReflect.Descriptor instead.

func (*Key) GetCollection 

func (x *Key) GetCollection() *Collection

func (*Key) GetId 

func (x *Key) GetId() string

func (*Key) ProtoMessage 

func (*Key) ProtoMessage()

func (*Key) ProtoReflect 

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

func (*Key) Reset 

func (x *Key) Reset()

func (*Key) String 

func (x *Key) String() string

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 PolicyResource added in v0.13.0 

type PolicyResource struct {
	Principals []*Resource `protobuf:"bytes,1,rep,name=principals,proto3" json:"principals,omitempty"`
	Actions    []Action    `protobuf:"varint,2,rep,packed,name=actions,proto3,enum=nitric.resource.v1.Action" json:"actions,omitempty"`
	Resources  []*Resource `protobuf:"bytes,3,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

func (*PolicyResource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use PolicyResource.ProtoReflect.Descriptor instead.

func (*PolicyResource) GetActions added in v0.13.0 

func (x *PolicyResource) GetActions() []Action

func (*PolicyResource) GetPrincipals added in v0.13.0 

func (x *PolicyResource) GetPrincipals() []*Resource

func (*PolicyResource) GetResources added in v0.13.0 

func (x *PolicyResource) GetResources() []*Resource

func (*PolicyResource) ProtoMessage added in v0.13.0 

func (*PolicyResource) ProtoMessage()

func (*PolicyResource) ProtoReflect added in v0.13.0 

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

func (*PolicyResource) Reset added in v0.13.0 

func (x *PolicyResource) Reset()

func (*PolicyResource) String added in v0.13.0 

func (x *PolicyResource) String() string

type QueryValue 

type QueryValue struct {
	Value []string `protobuf:"bytes,1,rep,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*QueryValue) Descriptor deprecated 

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

Deprecated: Use QueryValue.ProtoReflect.Descriptor instead.

func (*QueryValue) GetValue 

func (x *QueryValue) GetValue() []string

func (*QueryValue) ProtoMessage 

func (*QueryValue) ProtoMessage()

func (*QueryValue) ProtoReflect 

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

func (*QueryValue) Reset 

func (x *QueryValue) Reset()

func (*QueryValue) String 

func (x *QueryValue) String() string

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 QueueResource added in v0.13.0 

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

func (*QueueResource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use QueueResource.ProtoReflect.Descriptor instead.

func (*QueueResource) ProtoMessage added in v0.13.0 

func (*QueueResource) ProtoMessage()

func (*QueueResource) ProtoReflect added in v0.13.0 

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

func (*QueueResource) Reset added in v0.13.0 

func (x *QueueResource) Reset()

func (*QueueResource) String added in v0.13.0 

func (x *QueueResource) 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 QueueServiceClient 

type QueueServiceClient 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)
}

QueueServiceClient is the client API for QueueService 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 NewQueueServiceClient 

func NewQueueServiceClient(cc grpc.ClientConnInterface) QueueServiceClient

type QueueServiceServer 

type QueueServiceServer 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)
}

QueueServiceServer is the server API for QueueService service. All implementations should embed UnimplementedQueueServiceServer for forward compatibility

type Resource added in v0.13.0 

type Resource struct {
	Type ResourceType `protobuf:"varint,1,opt,name=type,proto3,enum=nitric.resource.v1.ResourceType" json:"type,omitempty"`
	Name string       `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*Resource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use Resource.ProtoReflect.Descriptor instead.

func (*Resource) GetName added in v0.13.0 

func (x *Resource) GetName() string

func (*Resource) GetType added in v0.13.0 

func (x *Resource) GetType() ResourceType

func (*Resource) ProtoMessage added in v0.13.0 

func (*Resource) ProtoMessage()

func (*Resource) ProtoReflect added in v0.13.0 

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

func (*Resource) Reset added in v0.13.0 

func (x *Resource) Reset()

func (*Resource) String added in v0.13.0 

func (x *Resource) String() string

type ResourceDeclareRequest added in v0.13.0 

type ResourceDeclareRequest struct {
	Resource *Resource `protobuf:"bytes,1,opt,name=resource,proto3" json:"resource,omitempty"`
	// Types that are assignable to Config:
	//	*ResourceDeclareRequest_Policy
	//	*ResourceDeclareRequest_Bucket
	//	*ResourceDeclareRequest_Queue
	//	*ResourceDeclareRequest_Topic
	//	*ResourceDeclareRequest_Collection
	//	*ResourceDeclareRequest_Secret
	Config isResourceDeclareRequest_Config `protobuf_oneof:"config"`
	// contains filtered or unexported fields
}

func (*ResourceDeclareRequest) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ResourceDeclareRequest.ProtoReflect.Descriptor instead.

func (*ResourceDeclareRequest) GetBucket added in v0.13.0 

func (x *ResourceDeclareRequest) GetBucket() *BucketResource

func (*ResourceDeclareRequest) GetCollection added in v0.13.0 

func (x *ResourceDeclareRequest) GetCollection() *CollectionResource

func (*ResourceDeclareRequest) GetConfig added in v0.13.0 

func (m *ResourceDeclareRequest) GetConfig() isResourceDeclareRequest_Config

func (*ResourceDeclareRequest) GetPolicy added in v0.13.0 

func (x *ResourceDeclareRequest) GetPolicy() *PolicyResource

func (*ResourceDeclareRequest) GetQueue added in v0.13.0 

func (x *ResourceDeclareRequest) GetQueue() *QueueResource

func (*ResourceDeclareRequest) GetResource added in v0.13.0 

func (x *ResourceDeclareRequest) GetResource() *Resource

func (*ResourceDeclareRequest) GetSecret added in v0.14.0 

func (x *ResourceDeclareRequest) GetSecret() *SecretResource

func (*ResourceDeclareRequest) GetTopic added in v0.13.0 

func (x *ResourceDeclareRequest) GetTopic() *TopicResource

func (*ResourceDeclareRequest) ProtoMessage added in v0.13.0 

func (*ResourceDeclareRequest) ProtoMessage()

func (*ResourceDeclareRequest) ProtoReflect added in v0.13.0 

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

func (*ResourceDeclareRequest) Reset added in v0.13.0 

func (x *ResourceDeclareRequest) Reset()

func (*ResourceDeclareRequest) String added in v0.13.0 

func (x *ResourceDeclareRequest) String() string

type ResourceDeclareRequest_Bucket added in v0.13.0 

type ResourceDeclareRequest_Bucket struct {
	Bucket *BucketResource `protobuf:"bytes,11,opt,name=bucket,proto3,oneof"`
}

type ResourceDeclareRequest_Collection added in v0.13.0 

type ResourceDeclareRequest_Collection struct {
	Collection *CollectionResource `protobuf:"bytes,14,opt,name=collection,proto3,oneof"`
}

type ResourceDeclareRequest_Policy added in v0.13.0 

type ResourceDeclareRequest_Policy struct {
	Policy *PolicyResource `protobuf:"bytes,10,opt,name=policy,proto3,oneof"`
}

type ResourceDeclareRequest_Queue added in v0.13.0 

type ResourceDeclareRequest_Queue struct {
	Queue *QueueResource `protobuf:"bytes,12,opt,name=queue,proto3,oneof"`
}

type ResourceDeclareRequest_Secret added in v0.14.0 

type ResourceDeclareRequest_Secret struct {
	Secret *SecretResource `protobuf:"bytes,15,opt,name=secret,proto3,oneof"`
}

type ResourceDeclareRequest_Topic added in v0.13.0 

type ResourceDeclareRequest_Topic struct {
	Topic *TopicResource `protobuf:"bytes,13,opt,name=topic,proto3,oneof"`
}

type ResourceDeclareResponse added in v0.13.0 

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

func (*ResourceDeclareResponse) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ResourceDeclareResponse.ProtoReflect.Descriptor instead.

func (*ResourceDeclareResponse) ProtoMessage added in v0.13.0 

func (*ResourceDeclareResponse) ProtoMessage()

func (*ResourceDeclareResponse) ProtoReflect added in v0.13.0 

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

func (*ResourceDeclareResponse) Reset added in v0.13.0 

func (x *ResourceDeclareResponse) Reset()

func (*ResourceDeclareResponse) String added in v0.13.0 

func (x *ResourceDeclareResponse) String() string

type ResourceServiceClient added in v0.13.0 

type ResourceServiceClient interface {
	// Declare a resource for the nitric application
	// At Deploy time this will create resources as part of the nitric stacks dependency graph
	// At runtime
	Declare(ctx context.Context, in *ResourceDeclareRequest, opts ...grpc.CallOption) (*ResourceDeclareResponse, error)
}

ResourceServiceClient is the client API for ResourceService 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 NewResourceServiceClient added in v0.13.0 

func NewResourceServiceClient(cc grpc.ClientConnInterface) ResourceServiceClient

type ResourceServiceServer added in v0.13.0 

type ResourceServiceServer interface {
	// Declare a resource for the nitric application
	// At Deploy time this will create resources as part of the nitric stacks dependency graph
	// At runtime
	Declare(context.Context, *ResourceDeclareRequest) (*ResourceDeclareResponse, error)
}

ResourceServiceServer is the server API for ResourceService service. All implementations should embed UnimplementedResourceServiceServer for forward compatibility

type ResourceType added in v0.13.0 

type ResourceType int32
const (
	ResourceType_Api          ResourceType = 0
	ResourceType_Function     ResourceType = 1
	ResourceType_Bucket       ResourceType = 2
	ResourceType_Queue        ResourceType = 3
	ResourceType_Topic        ResourceType = 4
	ResourceType_Schedule     ResourceType = 5
	ResourceType_Subscription ResourceType = 6
	ResourceType_Collection   ResourceType = 7
	ResourceType_Policy       ResourceType = 8
	ResourceType_Secret       ResourceType = 9
)

func (ResourceType) Descriptor added in v0.13.0 

func (ResourceType) Descriptor() protoreflect.EnumDescriptor

func (ResourceType) Enum added in v0.13.0 

func (x ResourceType) Enum() *ResourceType

func (ResourceType) EnumDescriptor deprecated added in v0.13.0 

func (ResourceType) EnumDescriptor() ([]byte, []int)

Deprecated: Use ResourceType.Descriptor instead.

func (ResourceType) Number added in v0.13.0 

func (x ResourceType) Number() protoreflect.EnumNumber

func (ResourceType) String added in v0.13.0 

func (x ResourceType) String() string

func (ResourceType) Type added in v0.13.0 

func (ResourceType) Type() protoreflect.EnumType

type ScheduleCron added in v0.13.0 

type ScheduleCron struct {
	Cron string `protobuf:"bytes,1,opt,name=cron,proto3" json:"cron,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleCron) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ScheduleCron.ProtoReflect.Descriptor instead.

func (*ScheduleCron) GetCron added in v0.13.0 

func (x *ScheduleCron) GetCron() string

func (*ScheduleCron) ProtoMessage added in v0.13.0 

func (*ScheduleCron) ProtoMessage()

func (*ScheduleCron) ProtoReflect added in v0.13.0 

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

func (*ScheduleCron) Reset added in v0.13.0 

func (x *ScheduleCron) Reset()

func (*ScheduleCron) String added in v0.13.0 

func (x *ScheduleCron) String() string

type ScheduleRate added in v0.13.0 

type ScheduleRate struct {
	Rate string `protobuf:"bytes,1,opt,name=rate,proto3" json:"rate,omitempty"`
	// contains filtered or unexported fields
}

func (*ScheduleRate) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ScheduleRate.ProtoReflect.Descriptor instead.

func (*ScheduleRate) GetRate added in v0.13.0 

func (x *ScheduleRate) GetRate() string

func (*ScheduleRate) ProtoMessage added in v0.13.0 

func (*ScheduleRate) ProtoMessage()

func (*ScheduleRate) ProtoReflect added in v0.13.0 

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

func (*ScheduleRate) Reset added in v0.13.0 

func (x *ScheduleRate) Reset()

func (*ScheduleRate) String added in v0.13.0 

func (x *ScheduleRate) String() string

type ScheduleWorker added in v0.13.0 

type ScheduleWorker struct {
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// Types that are assignable to Cadence:
	//	*ScheduleWorker_Rate
	//	*ScheduleWorker_Cron
	Cadence isScheduleWorker_Cadence `protobuf_oneof:"cadence"`
	// contains filtered or unexported fields
}

func (*ScheduleWorker) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use ScheduleWorker.ProtoReflect.Descriptor instead.

func (*ScheduleWorker) GetCadence added in v0.13.0 

func (m *ScheduleWorker) GetCadence() isScheduleWorker_Cadence

func (*ScheduleWorker) GetCron added in v0.13.0 

func (x *ScheduleWorker) GetCron() *ScheduleCron

func (*ScheduleWorker) GetKey added in v0.13.0 

func (x *ScheduleWorker) GetKey() string

func (*ScheduleWorker) GetRate added in v0.13.0 

func (x *ScheduleWorker) GetRate() *ScheduleRate

func (*ScheduleWorker) ProtoMessage added in v0.13.0 

func (*ScheduleWorker) ProtoMessage()

func (*ScheduleWorker) ProtoReflect added in v0.13.0 

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

func (*ScheduleWorker) Reset added in v0.13.0 

func (x *ScheduleWorker) Reset()

func (*ScheduleWorker) String added in v0.13.0 

func (x *ScheduleWorker) String() string

type ScheduleWorker_Cron added in v0.13.0 

type ScheduleWorker_Cron struct {
	Cron *ScheduleCron `protobuf:"bytes,11,opt,name=cron,proto3,oneof"`
}

type ScheduleWorker_Rate added in v0.13.0 

type ScheduleWorker_Rate struct {
	Rate *ScheduleRate `protobuf:"bytes,10,opt,name=rate,proto3,oneof"`
}

type Secret 

type Secret struct {

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

The secret container

func (*Secret) Descriptor deprecated 

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

Deprecated: Use Secret.ProtoReflect.Descriptor instead.

func (*Secret) GetName 

func (x *Secret) GetName() string

func (*Secret) ProtoMessage 

func (*Secret) ProtoMessage()

func (*Secret) ProtoReflect 

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

func (*Secret) Reset 

func (x *Secret) Reset()

func (*Secret) String 

func (x *Secret) String() string

type SecretAccessRequest 

type SecretAccessRequest struct {

	// The id of the secret
	SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"`
	// contains filtered or unexported fields
}

Request to get a secret from a Secret Store

func (*SecretAccessRequest) Descriptor deprecated 

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

Deprecated: Use SecretAccessRequest.ProtoReflect.Descriptor instead.

func (*SecretAccessRequest) GetSecretVersion 

func (x *SecretAccessRequest) GetSecretVersion() *SecretVersion

func (*SecretAccessRequest) ProtoMessage 

func (*SecretAccessRequest) ProtoMessage()

func (*SecretAccessRequest) ProtoReflect 

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

func (*SecretAccessRequest) Reset 

func (x *SecretAccessRequest) Reset()

func (*SecretAccessRequest) String 

func (x *SecretAccessRequest) String() string

type SecretAccessResponse 

type SecretAccessResponse struct {

	// The version of the secret that was requested
	SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"`
	// The value of the secret
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

The secret response

func (*SecretAccessResponse) Descriptor deprecated 

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

Deprecated: Use SecretAccessResponse.ProtoReflect.Descriptor instead.

func (*SecretAccessResponse) GetSecretVersion 

func (x *SecretAccessResponse) GetSecretVersion() *SecretVersion

func (*SecretAccessResponse) GetValue 

func (x *SecretAccessResponse) GetValue() []byte

func (*SecretAccessResponse) ProtoMessage 

func (*SecretAccessResponse) ProtoMessage()

func (*SecretAccessResponse) ProtoReflect 

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

func (*SecretAccessResponse) Reset 

func (x *SecretAccessResponse) Reset()

func (*SecretAccessResponse) String 

func (x *SecretAccessResponse) String() string

type SecretPutRequest 

type SecretPutRequest struct {

	// The Secret to put to the Secret store
	Secret *Secret `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"`
	// The value to assign to that secret
	Value []byte `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

Request to put a secret to a Secret Store

func (*SecretPutRequest) Descriptor deprecated 

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

Deprecated: Use SecretPutRequest.ProtoReflect.Descriptor instead.

func (*SecretPutRequest) GetSecret 

func (x *SecretPutRequest) GetSecret() *Secret

func (*SecretPutRequest) GetValue 

func (x *SecretPutRequest) GetValue() []byte

func (*SecretPutRequest) ProtoMessage 

func (*SecretPutRequest) ProtoMessage()

func (*SecretPutRequest) ProtoReflect 

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

func (*SecretPutRequest) Reset 

func (x *SecretPutRequest) Reset()

func (*SecretPutRequest) String 

func (x *SecretPutRequest) String() string

type SecretPutResponse 

type SecretPutResponse struct {

	// The id of the secret
	SecretVersion *SecretVersion `protobuf:"bytes,1,opt,name=secret_version,json=secretVersion,proto3" json:"secret_version,omitempty"`
	// contains filtered or unexported fields
}

Result from putting the secret to a Secret Store

func (*SecretPutResponse) Descriptor deprecated 

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

Deprecated: Use SecretPutResponse.ProtoReflect.Descriptor instead.

func (*SecretPutResponse) GetSecretVersion 

func (x *SecretPutResponse) GetSecretVersion() *SecretVersion

func (*SecretPutResponse) ProtoMessage 

func (*SecretPutResponse) ProtoMessage()

func (*SecretPutResponse) ProtoReflect 

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

func (*SecretPutResponse) Reset 

func (x *SecretPutResponse) Reset()

func (*SecretPutResponse) String 

func (x *SecretPutResponse) String() string

type SecretResource added in v0.14.0 

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

func (*SecretResource) Descriptor deprecated added in v0.14.0 

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

Deprecated: Use SecretResource.ProtoReflect.Descriptor instead.

func (*SecretResource) ProtoMessage added in v0.14.0 

func (*SecretResource) ProtoMessage()

func (*SecretResource) ProtoReflect added in v0.14.0 

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

func (*SecretResource) Reset added in v0.14.0 

func (x *SecretResource) Reset()

func (*SecretResource) String added in v0.14.0 

func (x *SecretResource) String() string

type SecretServiceClient 

type SecretServiceClient interface {
	// Updates a secret, creating a new one if it doesn't already exist
	Put(ctx context.Context, in *SecretPutRequest, opts ...grpc.CallOption) (*SecretPutResponse, error)
	// Gets a secret from a Secret Store
	Access(ctx context.Context, in *SecretAccessRequest, opts ...grpc.CallOption) (*SecretAccessResponse, error)
}

SecretServiceClient is the client API for SecretService 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 NewSecretServiceClient 

func NewSecretServiceClient(cc grpc.ClientConnInterface) SecretServiceClient

type SecretServiceServer 

type SecretServiceServer interface {
	// Updates a secret, creating a new one if it doesn't already exist
	Put(context.Context, *SecretPutRequest) (*SecretPutResponse, error)
	// Gets a secret from a Secret Store
	Access(context.Context, *SecretAccessRequest) (*SecretAccessResponse, error)
}

SecretServiceServer is the server API for SecretService service. All implementations should embed UnimplementedSecretServiceServer for forward compatibility

type SecretVersion 

type SecretVersion struct {

	// Reference to the secret container
	Secret *Secret `protobuf:"bytes,1,opt,name=secret,proto3" json:"secret,omitempty"`
	// The secret version
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"` //map<string, string> labels = 4; //Tags for GCP and azure,
	// contains filtered or unexported fields
}

A version of a secret

func (*SecretVersion) Descriptor deprecated 

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

Deprecated: Use SecretVersion.ProtoReflect.Descriptor instead.

func (*SecretVersion) GetSecret 

func (x *SecretVersion) GetSecret() *Secret

func (*SecretVersion) GetVersion 

func (x *SecretVersion) GetVersion() string

func (*SecretVersion) ProtoMessage 

func (*SecretVersion) ProtoMessage()

func (*SecretVersion) ProtoReflect 

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

func (*SecretVersion) Reset 

func (x *SecretVersion) Reset()

func (*SecretVersion) String 

func (x *SecretVersion) String() string

type ServerMessage 

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 

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

Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.

func (*ServerMessage) GetContent 

func (m *ServerMessage) GetContent() isServerMessage_Content

func (*ServerMessage) GetId 

func (x *ServerMessage) GetId() string

func (*ServerMessage) GetInitResponse 

func (x *ServerMessage) GetInitResponse() *InitResponse

func (*ServerMessage) GetTriggerRequest 

func (x *ServerMessage) GetTriggerRequest() *TriggerRequest

func (*ServerMessage) ProtoMessage 

func (*ServerMessage) ProtoMessage()

func (*ServerMessage) ProtoReflect 

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

func (*ServerMessage) Reset 

func (x *ServerMessage) Reset()

func (*ServerMessage) String 

func (x *ServerMessage) String() string

type ServerMessage_InitResponse 

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 

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 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 StoragePreSignUrlRequest 

type StoragePreSignUrlRequest 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 generate the signed URL for.
	// The URL and the token it contains will only be valid for operations on this resource specifically.
	Key       string                             `protobuf:"bytes,2,opt,name=key,proto3" json:"key,omitempty"`
	Operation StoragePreSignUrlRequest_Operation `` /* 130-byte string literal not displayed */
	// Expiry time in seconds for the token included in the signed URL.
	//  Time starts from when the access token is generated, not when this request is made.
	//  e.g. time.Now().Add(expiry * time.Second) on the server
	Expiry uint32 `protobuf:"varint,4,opt,name=expiry,proto3" json:"expiry,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a pre-signed URL for a file to perform a specific operation, such as read or write.

func (*StoragePreSignUrlRequest) Descriptor deprecated 

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

Deprecated: Use StoragePreSignUrlRequest.ProtoReflect.Descriptor instead.

func (*StoragePreSignUrlRequest) GetBucketName 

func (x *StoragePreSignUrlRequest) GetBucketName() string

func (*StoragePreSignUrlRequest) GetExpiry 

func (x *StoragePreSignUrlRequest) GetExpiry() uint32

func (*StoragePreSignUrlRequest) GetKey 

func (x *StoragePreSignUrlRequest) GetKey() string

func (*StoragePreSignUrlRequest) GetOperation 

func (x *StoragePreSignUrlRequest) GetOperation() StoragePreSignUrlRequest_Operation

func (*StoragePreSignUrlRequest) ProtoMessage 

func (*StoragePreSignUrlRequest) ProtoMessage()

func (*StoragePreSignUrlRequest) ProtoReflect 

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

func (*StoragePreSignUrlRequest) Reset 

func (x *StoragePreSignUrlRequest) Reset()

func (*StoragePreSignUrlRequest) String 

func (x *StoragePreSignUrlRequest) String() string

type StoragePreSignUrlRequest_Operation 

type StoragePreSignUrlRequest_Operation int32

Operation 

const (
	StoragePreSignUrlRequest_READ  StoragePreSignUrlRequest_Operation = 0
	StoragePreSignUrlRequest_WRITE StoragePreSignUrlRequest_Operation = 1
)

func (StoragePreSignUrlRequest_Operation) Descriptor 

func (StoragePreSignUrlRequest_Operation) Descriptor() protoreflect.EnumDescriptor

func (StoragePreSignUrlRequest_Operation) Enum 

func (x StoragePreSignUrlRequest_Operation) Enum() *StoragePreSignUrlRequest_Operation

func (StoragePreSignUrlRequest_Operation) EnumDescriptor deprecated 

func (StoragePreSignUrlRequest_Operation) EnumDescriptor() ([]byte, []int)

Deprecated: Use StoragePreSignUrlRequest_Operation.Descriptor instead.

func (StoragePreSignUrlRequest_Operation) Number 

func (x StoragePreSignUrlRequest_Operation) Number() protoreflect.EnumNumber

func (StoragePreSignUrlRequest_Operation) String 

func (x StoragePreSignUrlRequest_Operation) String() string

func (StoragePreSignUrlRequest_Operation) Type 

func (StoragePreSignUrlRequest_Operation) Type() protoreflect.EnumType

type StoragePreSignUrlResponse 

type StoragePreSignUrlResponse struct {

	// The pre-signed url, restricted to the operation, resource and expiry time specified in the request.
	Url string `protobuf:"bytes,1,opt,name=url,proto3" json:"url,omitempty"`
	// contains filtered or unexported fields
}

func (*StoragePreSignUrlResponse) Descriptor deprecated 

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

Deprecated: Use StoragePreSignUrlResponse.ProtoReflect.Descriptor instead.

func (*StoragePreSignUrlResponse) GetUrl 

func (x *StoragePreSignUrlResponse) GetUrl() string

func (*StoragePreSignUrlResponse) ProtoMessage 

func (*StoragePreSignUrlResponse) ProtoMessage()

func (*StoragePreSignUrlResponse) ProtoReflect 

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

func (*StoragePreSignUrlResponse) Reset 

func (x *StoragePreSignUrlResponse) Reset()

func (*StoragePreSignUrlResponse) String 

func (x *StoragePreSignUrlResponse) 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 StorageServiceClient 

type StorageServiceClient 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)
	// Generate a pre-signed URL for direct operations on an item
	PreSignUrl(ctx context.Context, in *StoragePreSignUrlRequest, opts ...grpc.CallOption) (*StoragePreSignUrlResponse, error)
}

StorageServiceClient is the client API for StorageService 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 NewStorageServiceClient 

func NewStorageServiceClient(cc grpc.ClientConnInterface) StorageServiceClient

type StorageServiceServer 

type StorageServiceServer 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)
	// Generate a pre-signed URL for direct operations on an item
	PreSignUrl(context.Context, *StoragePreSignUrlRequest) (*StoragePreSignUrlResponse, error)
}

StorageServiceServer is the server API for StorageService service. All implementations should embed UnimplementedStorageServiceServer 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 SubscriptionWorker added in v0.13.0 

type SubscriptionWorker struct {
	Topic string `protobuf:"bytes,1,opt,name=topic,proto3" json:"topic,omitempty"`
	// contains filtered or unexported fields
}

func (*SubscriptionWorker) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use SubscriptionWorker.ProtoReflect.Descriptor instead.

func (*SubscriptionWorker) GetTopic added in v0.13.0 

func (x *SubscriptionWorker) GetTopic() string

func (*SubscriptionWorker) ProtoMessage added in v0.13.0 

func (*SubscriptionWorker) ProtoMessage()

func (*SubscriptionWorker) ProtoReflect added in v0.13.0 

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

func (*SubscriptionWorker) Reset added in v0.13.0 

func (x *SubscriptionWorker) Reset()

func (*SubscriptionWorker) String added in v0.13.0 

func (x *SubscriptionWorker) String() string

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 TopicResource added in v0.13.0 

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

func (*TopicResource) Descriptor deprecated added in v0.13.0 

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

Deprecated: Use TopicResource.ProtoReflect.Descriptor instead.

func (*TopicResource) ProtoMessage added in v0.13.0 

func (*TopicResource) ProtoMessage()

func (*TopicResource) ProtoReflect added in v0.13.0 

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

func (*TopicResource) Reset added in v0.13.0 

func (x *TopicResource) Reset()

func (*TopicResource) String added in v0.13.0 

func (x *TopicResource) String() string

type TopicResponseContext 

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 

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

Deprecated: Use TopicResponseContext.ProtoReflect.Descriptor instead.

func (*TopicResponseContext) GetSuccess 

func (x *TopicResponseContext) GetSuccess() bool

func (*TopicResponseContext) ProtoMessage 

func (*TopicResponseContext) ProtoMessage()

func (*TopicResponseContext) ProtoReflect 

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

func (*TopicResponseContext) Reset 

func (x *TopicResponseContext) Reset()

func (*TopicResponseContext) String 

func (x *TopicResponseContext) String() string

type TopicServiceClient 

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

TopicServiceClient is the client API for TopicService 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 NewTopicServiceClient 

func NewTopicServiceClient(cc grpc.ClientConnInterface) TopicServiceClient

type TopicServiceServer 

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

TopicServiceServer is the server API for TopicService service. All implementations should embed UnimplementedTopicServiceServer for forward compatibility

type TopicTriggerContext 

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 

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

Deprecated: Use TopicTriggerContext.ProtoReflect.Descriptor instead.

func (*TopicTriggerContext) GetTopic 

func (x *TopicTriggerContext) GetTopic() string

func (*TopicTriggerContext) ProtoMessage 

func (*TopicTriggerContext) ProtoMessage()

func (*TopicTriggerContext) ProtoReflect 

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

func (*TopicTriggerContext) Reset 

func (x *TopicTriggerContext) Reset()

func (*TopicTriggerContext) String 

func (x *TopicTriggerContext) String() string

type TriggerRequest 

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 

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

Deprecated: Use TriggerRequest.ProtoReflect.Descriptor instead.

func (*TriggerRequest) GetContext 

func (m *TriggerRequest) GetContext() isTriggerRequest_Context

func (*TriggerRequest) GetData 

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

func (*TriggerRequest) GetHttp 

func (x *TriggerRequest) GetHttp() *HttpTriggerContext

func (*TriggerRequest) GetMimeType 

func (x *TriggerRequest) GetMimeType() string

func (*TriggerRequest) GetTopic 

func (x *TriggerRequest) GetTopic() *TopicTriggerContext

func (*TriggerRequest) ProtoMessage 

func (*TriggerRequest) ProtoMessage()

func (*TriggerRequest) ProtoReflect 

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

func (*TriggerRequest) Reset 

func (x *TriggerRequest) Reset()

func (*TriggerRequest) String 

func (x *TriggerRequest) String() string

type TriggerRequest_Http 

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

type TriggerRequest_Topic 

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

type TriggerResponse 

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 

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

Deprecated: Use TriggerResponse.ProtoReflect.Descriptor instead.

func (*TriggerResponse) GetContext 

func (m *TriggerResponse) GetContext() isTriggerResponse_Context

func (*TriggerResponse) GetData 

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

func (*TriggerResponse) GetHttp 

func (x *TriggerResponse) GetHttp() *HttpResponseContext

func (*TriggerResponse) GetTopic 

func (x *TriggerResponse) GetTopic() *TopicResponseContext

func (*TriggerResponse) ProtoMessage 

func (*TriggerResponse) ProtoMessage()

func (*TriggerResponse) ProtoReflect 

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

func (*TriggerResponse) Reset 

func (x *TriggerResponse) Reset()

func (*TriggerResponse) String 

func (x *TriggerResponse) String() string

type TriggerResponse_Http 

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

type TriggerResponse_Topic 

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

type UnimplementedDocumentServiceServer 

type UnimplementedDocumentServiceServer struct {
}

UnimplementedDocumentServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedDocumentServiceServer) Delete 

func (UnimplementedDocumentServiceServer) Delete(context.Context, *DocumentDeleteRequest) (*DocumentDeleteResponse, error)

func (UnimplementedDocumentServiceServer) Get 

func (UnimplementedDocumentServiceServer) Get(context.Context, *DocumentGetRequest) (*DocumentGetResponse, error)

func (UnimplementedDocumentServiceServer) Query 

func (UnimplementedDocumentServiceServer) Query(context.Context, *DocumentQueryRequest) (*DocumentQueryResponse, error)

func (UnimplementedDocumentServiceServer) QueryStream 

func (UnimplementedDocumentServiceServer) QueryStream(*DocumentQueryStreamRequest, DocumentService_QueryStreamServer) error

func (UnimplementedDocumentServiceServer) Set 

func (UnimplementedDocumentServiceServer) Set(context.Context, *DocumentSetRequest) (*DocumentSetResponse, error)

type UnimplementedEventServiceServer 

type UnimplementedEventServiceServer struct {
}

UnimplementedEventServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedEventServiceServer) Publish 

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

type UnimplementedFaasServiceServer 

type UnimplementedFaasServiceServer struct {
}

UnimplementedFaasServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedFaasServiceServer) TriggerStream 

func (UnimplementedFaasServiceServer) TriggerStream(FaasService_TriggerStreamServer) error

type UnimplementedQueueServiceServer 

type UnimplementedQueueServiceServer struct {
}

UnimplementedQueueServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedQueueServiceServer) Complete 

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

func (UnimplementedQueueServiceServer) Receive 

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

func (UnimplementedQueueServiceServer) Send 

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

func (UnimplementedQueueServiceServer) SendBatch 

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

type UnimplementedResourceServiceServer added in v0.13.0 

type UnimplementedResourceServiceServer struct {
}

UnimplementedResourceServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedResourceServiceServer) Declare added in v0.13.0 

func (UnimplementedResourceServiceServer) Declare(context.Context, *ResourceDeclareRequest) (*ResourceDeclareResponse, error)

type UnimplementedSecretServiceServer 

type UnimplementedSecretServiceServer struct {
}

UnimplementedSecretServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedSecretServiceServer) Access 

func (UnimplementedSecretServiceServer) Access(context.Context, *SecretAccessRequest) (*SecretAccessResponse, error)

func (UnimplementedSecretServiceServer) Put 

func (UnimplementedSecretServiceServer) Put(context.Context, *SecretPutRequest) (*SecretPutResponse, error)

type UnimplementedStorageServiceServer 

type UnimplementedStorageServiceServer struct {
}

UnimplementedStorageServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedStorageServiceServer) Delete 

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

func (UnimplementedStorageServiceServer) PreSignUrl 

func (UnimplementedStorageServiceServer) PreSignUrl(context.Context, *StoragePreSignUrlRequest) (*StoragePreSignUrlResponse, error)

func (UnimplementedStorageServiceServer) Read 

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

func (UnimplementedStorageServiceServer) Write 

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

type UnimplementedTopicServiceServer 

type UnimplementedTopicServiceServer struct {
}

UnimplementedTopicServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedTopicServiceServer) List 

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

type UnsafeDocumentServiceServer 

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

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

type UnsafeEventServiceServer 

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

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

type UnsafeFaasServiceServer 

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

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

type UnsafeQueueServiceServer 

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

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

type UnsafeResourceServiceServer added in v0.13.0 

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

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

type UnsafeSecretServiceServer 

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

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

type UnsafeStorageServiceServer 

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

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

type UnsafeTopicServiceServer 

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

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