storagepb

package
v0.0.0-...-997c607 Latest Latest
Warning

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

Go to latest
Published: May 1, 2024 License: Apache-2.0 Imports: 9 Imported by: 13

Documentation

Index

Constants

This section is empty.

Variables

View Source
var (
	BlobEventType_name = map[int32]string{
		0: "Created",
		1: "Deleted",
	}
	BlobEventType_value = map[string]int32{
		"Created": 0,
		"Deleted": 1,
	}
)

Enum value maps for BlobEventType.

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 File_nitric_proto_storage_v1_storage_proto protoreflect.FileDescriptor
View Source
var StorageListener_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.proto.storage.v1.StorageListener",
	HandlerType: (*StorageListenerServer)(nil),
	Methods:     []grpc.MethodDesc{},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "Listen",
			Handler:       _StorageListener_Listen_Handler,
			ServerStreams: true,
			ClientStreams: true,
		},
	},
	Metadata: "nitric/proto/storage/v1/storage.proto",
}

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

View Source
var Storage_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.proto.storage.v1.Storage",
	HandlerType: (*StorageServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Read",
			Handler:    _Storage_Read_Handler,
		},
		{
			MethodName: "Write",
			Handler:    _Storage_Write_Handler,
		},
		{
			MethodName: "Delete",
			Handler:    _Storage_Delete_Handler,
		},
		{
			MethodName: "PreSignUrl",
			Handler:    _Storage_PreSignUrl_Handler,
		},
		{
			MethodName: "ListBlobs",
			Handler:    _Storage_ListBlobs_Handler,
		},
		{
			MethodName: "Exists",
			Handler:    _Storage_Exists_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "nitric/proto/storage/v1/storage.proto",
}

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

Functions

func RegisterStorageListenerServer

func RegisterStorageListenerServer(s grpc.ServiceRegistrar, srv StorageListenerServer)

func RegisterStorageServer

func RegisterStorageServer(s grpc.ServiceRegistrar, srv StorageServer)

Types

type Blob

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

func (*Blob) Descriptor deprecated

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

Deprecated: Use Blob.ProtoReflect.Descriptor instead.

func (*Blob) GetKey

func (x *Blob) GetKey() string

func (*Blob) ProtoMessage

func (*Blob) ProtoMessage()

func (*Blob) ProtoReflect

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

func (*Blob) Reset

func (x *Blob) Reset()

func (*Blob) String

func (x *Blob) String() string

type BlobEvent

type BlobEvent struct {

	// The key of the blob the event is for
	Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"`
	// The type of event that occurred
	Type BlobEventType `protobuf:"varint,2,opt,name=type,proto3,enum=nitric.proto.storage.v1.BlobEventType" json:"type,omitempty"`
	// contains filtered or unexported fields
}

func (*BlobEvent) Descriptor deprecated

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

Deprecated: Use BlobEvent.ProtoReflect.Descriptor instead.

func (*BlobEvent) GetKey

func (x *BlobEvent) GetKey() string

func (*BlobEvent) GetType

func (x *BlobEvent) GetType() BlobEventType

func (*BlobEvent) ProtoMessage

func (*BlobEvent) ProtoMessage()

func (*BlobEvent) ProtoReflect

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

func (*BlobEvent) Reset

func (x *BlobEvent) Reset()

func (*BlobEvent) String

func (x *BlobEvent) String() string

type BlobEventRequest

type BlobEventRequest struct {
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Types that are assignable to Event:
	//
	//	*BlobEventRequest_BlobEvent
	Event isBlobEventRequest_Event `protobuf_oneof:"event"`
	// contains filtered or unexported fields
}

func (*BlobEventRequest) Descriptor deprecated

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

Deprecated: Use BlobEventRequest.ProtoReflect.Descriptor instead.

func (*BlobEventRequest) GetBlobEvent

func (x *BlobEventRequest) GetBlobEvent() *BlobEvent

func (*BlobEventRequest) GetBucketName

func (x *BlobEventRequest) GetBucketName() string

func (*BlobEventRequest) GetEvent

func (m *BlobEventRequest) GetEvent() isBlobEventRequest_Event

func (*BlobEventRequest) ProtoMessage

func (*BlobEventRequest) ProtoMessage()

func (*BlobEventRequest) ProtoReflect

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

func (*BlobEventRequest) Reset

func (x *BlobEventRequest) Reset()

func (*BlobEventRequest) String

func (x *BlobEventRequest) String() string

type BlobEventRequest_BlobEvent

type BlobEventRequest_BlobEvent struct {
	BlobEvent *BlobEvent `protobuf:"bytes,10,opt,name=blob_event,json=blobEvent,proto3,oneof"`
}

type BlobEventResponse

type BlobEventResponse struct {
	Success bool `protobuf:"varint,1,opt,name=success,proto3" json:"success,omitempty"`
	// contains filtered or unexported fields
}

func (*BlobEventResponse) Descriptor deprecated

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

Deprecated: Use BlobEventResponse.ProtoReflect.Descriptor instead.

func (*BlobEventResponse) GetSuccess

func (x *BlobEventResponse) GetSuccess() bool

func (*BlobEventResponse) ProtoMessage

func (*BlobEventResponse) ProtoMessage()

func (*BlobEventResponse) ProtoReflect

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

func (*BlobEventResponse) Reset

func (x *BlobEventResponse) Reset()

func (*BlobEventResponse) String

func (x *BlobEventResponse) String() string

type BlobEventType

type BlobEventType int32
const (
	BlobEventType_Created BlobEventType = 0
	BlobEventType_Deleted BlobEventType = 1
)

func (BlobEventType) Descriptor

func (BlobEventType) Enum

func (x BlobEventType) Enum() *BlobEventType

func (BlobEventType) EnumDescriptor deprecated

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

Deprecated: Use BlobEventType.Descriptor instead.

func (BlobEventType) Number

func (BlobEventType) String

func (x BlobEventType) String() string

func (BlobEventType) Type

type ClientMessage

type ClientMessage struct {

	// globally unique ID of the request/response pair
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Content:
	//
	//	*ClientMessage_RegistrationRequest
	//	*ClientMessage_BlobEventResponse
	Content isClientMessage_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

ClientMessages are sent from the service to the nitric server

func (*ClientMessage) Descriptor deprecated

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

Deprecated: Use ClientMessage.ProtoReflect.Descriptor instead.

func (*ClientMessage) GetBlobEventResponse

func (x *ClientMessage) GetBlobEventResponse() *BlobEventResponse

func (*ClientMessage) GetContent

func (m *ClientMessage) GetContent() isClientMessage_Content

func (*ClientMessage) GetId

func (x *ClientMessage) GetId() string

func (*ClientMessage) GetRegistrationRequest

func (x *ClientMessage) GetRegistrationRequest() *RegistrationRequest

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_BlobEventResponse

type ClientMessage_BlobEventResponse struct {
	// Response to a blob event (change to a blob)
	BlobEventResponse *BlobEventResponse `protobuf:"bytes,3,opt,name=blob_event_response,json=blobEventResponse,proto3,oneof"`
}

type ClientMessage_RegistrationRequest

type ClientMessage_RegistrationRequest struct {
	// Watch for changes on a bucket
	RegistrationRequest *RegistrationRequest `protobuf:"bytes,2,opt,name=registration_request,json=registrationRequest,proto3,oneof"`
}

type RegistrationRequest

type RegistrationRequest struct {

	// Name of the bucket to watch
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	// Event type to listen for
	BlobEventType BlobEventType `` /* 146-byte string literal not displayed */
	// A blob key prefix to filter events by
	KeyPrefixFilter string `protobuf:"bytes,3,opt,name=key_prefix_filter,json=keyPrefixFilter,proto3" json:"key_prefix_filter,omitempty"`
	// contains filtered or unexported fields
}

func (*RegistrationRequest) Descriptor deprecated

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

Deprecated: Use RegistrationRequest.ProtoReflect.Descriptor instead.

func (*RegistrationRequest) GetBlobEventType

func (x *RegistrationRequest) GetBlobEventType() BlobEventType

func (*RegistrationRequest) GetBucketName

func (x *RegistrationRequest) GetBucketName() string

func (*RegistrationRequest) GetKeyPrefixFilter

func (x *RegistrationRequest) GetKeyPrefixFilter() string

func (*RegistrationRequest) ProtoMessage

func (*RegistrationRequest) ProtoMessage()

func (*RegistrationRequest) ProtoReflect

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

func (*RegistrationRequest) Reset

func (x *RegistrationRequest) Reset()

func (*RegistrationRequest) String

func (x *RegistrationRequest) String() string

type RegistrationResponse

type RegistrationResponse struct {

	// The ID of the registration
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// contains filtered or unexported fields
}

func (*RegistrationResponse) Descriptor deprecated

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

Deprecated: Use RegistrationResponse.ProtoReflect.Descriptor instead.

func (*RegistrationResponse) GetId

func (x *RegistrationResponse) GetId() string

func (*RegistrationResponse) ProtoMessage

func (*RegistrationResponse) ProtoMessage()

func (*RegistrationResponse) ProtoReflect

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

func (*RegistrationResponse) Reset

func (x *RegistrationResponse) Reset()

func (*RegistrationResponse) String

func (x *RegistrationResponse) String() string

type ServerMessage

type ServerMessage struct {

	// globally unique ID of the request/response pair
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Types that are assignable to Content:
	//
	//	*ServerMessage_RegistrationResponse
	//	*ServerMessage_BlobEventRequest
	Content isServerMessage_Content `protobuf_oneof:"content"`
	// contains filtered or unexported fields
}

ServerMessages are sent from the nitric server to the service

func (*ServerMessage) Descriptor deprecated

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

Deprecated: Use ServerMessage.ProtoReflect.Descriptor instead.

func (*ServerMessage) GetBlobEventRequest

func (x *ServerMessage) GetBlobEventRequest() *BlobEventRequest

func (*ServerMessage) GetContent

func (m *ServerMessage) GetContent() isServerMessage_Content

func (*ServerMessage) GetId

func (x *ServerMessage) GetId() string

func (*ServerMessage) GetRegistrationResponse

func (x *ServerMessage) GetRegistrationResponse() *RegistrationResponse

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_BlobEventRequest

type ServerMessage_BlobEventRequest struct {
	// Event for a blob in a bucket
	BlobEventRequest *BlobEventRequest `protobuf:"bytes,3,opt,name=blob_event_request,json=blobEventRequest,proto3,oneof"`
}

type ServerMessage_RegistrationResponse

type ServerMessage_RegistrationResponse struct {
	// Watch for changes on a bucket
	RegistrationResponse *RegistrationResponse `protobuf:"bytes,2,opt,name=registration_response,json=registrationResponse,proto3,oneof"`
}

type StorageClient

type StorageClient interface {
	// Retrieve an item from a bucket
	Read(ctx context.Context, in *StorageReadRequest, opts ...grpc.CallOption) (*StorageReadResponse, error)
	// Store an item to a bucket
	Write(ctx context.Context, in *StorageWriteRequest, opts ...grpc.CallOption) (*StorageWriteResponse, error)
	// Delete an item from a bucket
	Delete(ctx context.Context, in *StorageDeleteRequest, opts ...grpc.CallOption) (*StorageDeleteResponse, error)
	// Generate a pre-signed URL for direct operations on an item
	PreSignUrl(ctx context.Context, in *StoragePreSignUrlRequest, opts ...grpc.CallOption) (*StoragePreSignUrlResponse, error)
	// List blobs currently in the bucket
	ListBlobs(ctx context.Context, in *StorageListBlobsRequest, opts ...grpc.CallOption) (*StorageListBlobsResponse, error)
	// Determine is an object exists in a bucket
	Exists(ctx context.Context, in *StorageExistsRequest, opts ...grpc.CallOption) (*StorageExistsResponse, error)
}

StorageClient is the client API for Storage service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewStorageClient

func NewStorageClient(cc grpc.ClientConnInterface) StorageClient

type StorageDeleteRequest

type StorageDeleteRequest struct {

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

Request to delete a storage item

func (*StorageDeleteRequest) Descriptor deprecated

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

Deprecated: Use StorageDeleteRequest.ProtoReflect.Descriptor instead.

func (*StorageDeleteRequest) GetBucketName

func (x *StorageDeleteRequest) GetBucketName() string

func (*StorageDeleteRequest) GetKey

func (x *StorageDeleteRequest) GetKey() string

func (*StorageDeleteRequest) ProtoMessage

func (*StorageDeleteRequest) ProtoMessage()

func (*StorageDeleteRequest) ProtoReflect

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

func (*StorageDeleteRequest) Reset

func (x *StorageDeleteRequest) Reset()

func (*StorageDeleteRequest) String

func (x *StorageDeleteRequest) String() string

type StorageDeleteResponse

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

Result of deleting a storage item

func (*StorageDeleteResponse) Descriptor deprecated

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

Deprecated: Use StorageDeleteResponse.ProtoReflect.Descriptor instead.

func (*StorageDeleteResponse) ProtoMessage

func (*StorageDeleteResponse) ProtoMessage()

func (*StorageDeleteResponse) ProtoReflect

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

func (*StorageDeleteResponse) Reset

func (x *StorageDeleteResponse) Reset()

func (*StorageDeleteResponse) String

func (x *StorageDeleteResponse) String() string

type StorageExistsRequest

type StorageExistsRequest struct {
	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
}

func (*StorageExistsRequest) Descriptor deprecated

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

Deprecated: Use StorageExistsRequest.ProtoReflect.Descriptor instead.

func (*StorageExistsRequest) GetBucketName

func (x *StorageExistsRequest) GetBucketName() string

func (*StorageExistsRequest) GetKey

func (x *StorageExistsRequest) GetKey() string

func (*StorageExistsRequest) ProtoMessage

func (*StorageExistsRequest) ProtoMessage()

func (*StorageExistsRequest) ProtoReflect

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

func (*StorageExistsRequest) Reset

func (x *StorageExistsRequest) Reset()

func (*StorageExistsRequest) String

func (x *StorageExistsRequest) String() string

type StorageExistsResponse

type StorageExistsResponse struct {
	Exists bool `protobuf:"varint,1,opt,name=exists,proto3" json:"exists,omitempty"`
	// contains filtered or unexported fields
}

func (*StorageExistsResponse) Descriptor deprecated

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

Deprecated: Use StorageExistsResponse.ProtoReflect.Descriptor instead.

func (*StorageExistsResponse) GetExists

func (x *StorageExistsResponse) GetExists() bool

func (*StorageExistsResponse) ProtoMessage

func (*StorageExistsResponse) ProtoMessage()

func (*StorageExistsResponse) ProtoReflect

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

func (*StorageExistsResponse) Reset

func (x *StorageExistsResponse) Reset()

func (*StorageExistsResponse) String

func (x *StorageExistsResponse) String() string

type StorageListBlobsRequest

type StorageListBlobsRequest struct {
	BucketName string `protobuf:"bytes,1,opt,name=bucket_name,json=bucketName,proto3" json:"bucket_name,omitempty"`
	Prefix     string `protobuf:"bytes,2,opt,name=prefix,proto3" json:"prefix,omitempty"`
	// contains filtered or unexported fields
}

func (*StorageListBlobsRequest) Descriptor deprecated

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

Deprecated: Use StorageListBlobsRequest.ProtoReflect.Descriptor instead.

func (*StorageListBlobsRequest) GetBucketName

func (x *StorageListBlobsRequest) GetBucketName() string

func (*StorageListBlobsRequest) GetPrefix

func (x *StorageListBlobsRequest) GetPrefix() string

func (*StorageListBlobsRequest) ProtoMessage

func (*StorageListBlobsRequest) ProtoMessage()

func (*StorageListBlobsRequest) ProtoReflect

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

func (*StorageListBlobsRequest) Reset

func (x *StorageListBlobsRequest) Reset()

func (*StorageListBlobsRequest) String

func (x *StorageListBlobsRequest) String() string

type StorageListBlobsResponse

type StorageListBlobsResponse struct {

	// keys of the blobs in the bucket
	Blobs []*Blob `protobuf:"bytes,1,rep,name=blobs,proto3" json:"blobs,omitempty"`
	// contains filtered or unexported fields
}

func (*StorageListBlobsResponse) Descriptor deprecated

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

Deprecated: Use StorageListBlobsResponse.ProtoReflect.Descriptor instead.

func (*StorageListBlobsResponse) GetBlobs

func (x *StorageListBlobsResponse) GetBlobs() []*Blob

func (*StorageListBlobsResponse) ProtoMessage

func (*StorageListBlobsResponse) ProtoMessage()

func (*StorageListBlobsResponse) ProtoReflect

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

func (*StorageListBlobsResponse) Reset

func (x *StorageListBlobsResponse) Reset()

func (*StorageListBlobsResponse) String

func (x *StorageListBlobsResponse) String() string

type StorageListenerClient

type StorageListenerClient interface {
	// Listen for changes on a bucket
	Listen(ctx context.Context, opts ...grpc.CallOption) (StorageListener_ListenClient, error)
}

StorageListenerClient is the client API for StorageListener 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.

type StorageListenerServer

type StorageListenerServer interface {
	// Listen for changes on a bucket
	Listen(StorageListener_ListenServer) error
}

StorageListenerServer is the server API for StorageListener service. All implementations should embed UnimplementedStorageListenerServer for forward compatibility

type StorageListener_ListenClient

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

type StorageListener_ListenServer

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

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 `` /* 136-byte string literal not displayed */
	// Expiry defined as as protobuf duration
	Expiry *durationpb.Duration `protobuf:"bytes,4,opt,name=expiry,proto3" json:"expiry,omitempty"`
	// contains filtered or unexported fields
}

Request to generate a pre-signed URL for a blob 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 (*StoragePreSignUrlRequest) GetKey

func (x *StoragePreSignUrlRequest) GetKey() string

func (*StoragePreSignUrlRequest) GetOperation

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

func (StoragePreSignUrlRequest_Operation) EnumDescriptor deprecated

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

Deprecated: Use StoragePreSignUrlRequest_Operation.Descriptor instead.

func (StoragePreSignUrlRequest_Operation) Number

func (StoragePreSignUrlRequest_Operation) String

func (StoragePreSignUrlRequest_Operation) Type

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 (*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 StorageServer

type StorageServer interface {
	// Retrieve an item from a bucket
	Read(context.Context, *StorageReadRequest) (*StorageReadResponse, error)
	// Store an item to a bucket
	Write(context.Context, *StorageWriteRequest) (*StorageWriteResponse, error)
	// Delete an item from a bucket
	Delete(context.Context, *StorageDeleteRequest) (*StorageDeleteResponse, error)
	// Generate a pre-signed URL for direct operations on an item
	PreSignUrl(context.Context, *StoragePreSignUrlRequest) (*StoragePreSignUrlResponse, error)
	// List blobs currently in the bucket
	ListBlobs(context.Context, *StorageListBlobsRequest) (*StorageListBlobsResponse, error)
	// Determine is an object exists in a bucket
	Exists(context.Context, *StorageExistsRequest) (*StorageExistsResponse, error)
}

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

type StorageWriteRequest

type StorageWriteRequest struct {

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

Request to put (create/update) a storage item

func (*StorageWriteRequest) Descriptor deprecated

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

Deprecated: Use StorageWriteRequest.ProtoReflect.Descriptor instead.

func (*StorageWriteRequest) GetBody

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

func (*StorageWriteRequest) GetBucketName

func (x *StorageWriteRequest) GetBucketName() string

func (*StorageWriteRequest) GetKey

func (x *StorageWriteRequest) GetKey() string

func (*StorageWriteRequest) ProtoMessage

func (*StorageWriteRequest) ProtoMessage()

func (*StorageWriteRequest) ProtoReflect

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

func (*StorageWriteRequest) Reset

func (x *StorageWriteRequest) Reset()

func (*StorageWriteRequest) String

func (x *StorageWriteRequest) String() string

type StorageWriteResponse

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

Result of putting a storage item

func (*StorageWriteResponse) Descriptor deprecated

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

Deprecated: Use StorageWriteResponse.ProtoReflect.Descriptor instead.

func (*StorageWriteResponse) ProtoMessage

func (*StorageWriteResponse) ProtoMessage()

func (*StorageWriteResponse) ProtoReflect

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

func (*StorageWriteResponse) Reset

func (x *StorageWriteResponse) Reset()

func (*StorageWriteResponse) String

func (x *StorageWriteResponse) String() string

type UnimplementedStorageListenerServer

type UnimplementedStorageListenerServer struct {
}

UnimplementedStorageListenerServer should be embedded to have forward compatible implementations.

func (UnimplementedStorageListenerServer) Listen

type UnimplementedStorageServer

type UnimplementedStorageServer struct {
}

UnimplementedStorageServer should be embedded to have forward compatible implementations.

func (UnimplementedStorageServer) Delete

func (UnimplementedStorageServer) Exists

func (UnimplementedStorageServer) Read

func (UnimplementedStorageServer) Write

type UnsafeStorageListenerServer

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

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

type UnsafeStorageServer

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

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

Jump to

Keyboard shortcuts

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