storagepb

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

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

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

Documentation

Index

Constants

This section is empty.

Variables

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_storage_v2_storage_proto protoreflect.FileDescriptor
View Source 
var Storage_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "nitric.proto.storage.v2.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: "storage/v2/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 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 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 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 (x *StoragePreSignUrlRequest) GetExpiry() *durationpb.Duration

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 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)
	// contains filtered or unexported methods
}

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

type StorageWriteRequest 

type StorageWriteRequest struct {

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

Request to put (create/update) a storage item

func (*StorageWriteRequest) Descriptor deprecated 

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

Deprecated: Use StorageWriteRequest.ProtoReflect.Descriptor instead.

func (*StorageWriteRequest) GetBody 

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

func (*StorageWriteRequest) GetBucketName 

func (x *StorageWriteRequest) GetBucketName() string

func (*StorageWriteRequest) GetKey 

func (x *StorageWriteRequest) GetKey() string

func (*StorageWriteRequest) ProtoMessage 

func (*StorageWriteRequest) ProtoMessage()

func (*StorageWriteRequest) ProtoReflect 

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

func (*StorageWriteRequest) Reset 

func (x *StorageWriteRequest) Reset()

func (*StorageWriteRequest) String 

func (x *StorageWriteRequest) String() string

type StorageWriteResponse 

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

Result of putting a storage item

func (*StorageWriteResponse) Descriptor deprecated 

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

Deprecated: Use StorageWriteResponse.ProtoReflect.Descriptor instead.

func (*StorageWriteResponse) ProtoMessage 

func (*StorageWriteResponse) ProtoMessage()

func (*StorageWriteResponse) ProtoReflect 

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

func (*StorageWriteResponse) Reset 

func (x *StorageWriteResponse) Reset()

func (*StorageWriteResponse) String 

func (x *StorageWriteResponse) String() string

type UnimplementedStorageServer 

type UnimplementedStorageServer struct {
}

UnimplementedStorageServer must be embedded to have forward compatible implementations.

func (UnimplementedStorageServer) Delete 

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

func (UnimplementedStorageServer) Exists 

func (UnimplementedStorageServer) Exists(context.Context, *StorageExistsRequest) (*StorageExistsResponse, error)

func (UnimplementedStorageServer) ListBlobs 

func (UnimplementedStorageServer) ListBlobs(context.Context, *StorageListBlobsRequest) (*StorageListBlobsResponse, error)

func (UnimplementedStorageServer) PreSignUrl 

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

func (UnimplementedStorageServer) Read 

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

func (UnimplementedStorageServer) Write 

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

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.

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.