filemanagement

package
v1.14.0 Latest Latest
Warning

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

 Go to latest Published: Mar 27, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	FileManagement_UploadFile_FullMethodName      = "/services.filemanagement.v1.FileManagement/UploadFile"
	FileManagement_GetFile_FullMethodName         = "/services.filemanagement.v1.FileManagement/GetFile"
	FileManagement_DeleteFile_FullMethodName      = "/services.filemanagement.v1.FileManagement/DeleteFile"
	FileManagement_ListFiles_FullMethodName       = "/services.filemanagement.v1.FileManagement/ListFiles"
	FileManagement_GetStorageStats_FullMethodName = "/services.filemanagement.v1.FileManagement/GetStorageStats"
)

Variables

View Source 
var FileManagement_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "services.filemanagement.v1.FileManagement",
	HandlerType: (*FileManagementServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "UploadFile",
			Handler:    _FileManagement_UploadFile_Handler,
		},
		{
			MethodName: "GetFile",
			Handler:    _FileManagement_GetFile_Handler,
		},
		{
			MethodName: "DeleteFile",
			Handler:    _FileManagement_DeleteFile_Handler,
		},
		{
			MethodName: "ListFiles",
			Handler:    _FileManagement_ListFiles_Handler,
		},
		{
			MethodName: "GetStorageStats",
			Handler:    _FileManagement_GetStorageStats_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "services/file-management/v1/file-management.proto",
}

FileManagement_ServiceDesc is the grpc.ServiceDesc for FileManagement 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_services_file_management_v1_file_management_proto protoreflect.FileDescriptor

Functions

func RegisterFileManagementServer 

func RegisterFileManagementServer(s grpc.ServiceRegistrar, srv FileManagementServer)

Types

type DeleteFileRequest 

type DeleteFileRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // ID of file to delete
	// contains filtered or unexported fields
}

Request to delete a file from Trinsic's CDN by ID

func (*DeleteFileRequest) Descriptor deprecated 

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

Deprecated: Use DeleteFileRequest.ProtoReflect.Descriptor instead.

func (*DeleteFileRequest) GetId 

func (x *DeleteFileRequest) GetId() string

func (*DeleteFileRequest) ProtoMessage 

func (*DeleteFileRequest) ProtoMessage()

func (*DeleteFileRequest) ProtoReflect 

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

func (*DeleteFileRequest) Reset 

func (x *DeleteFileRequest) Reset()

func (*DeleteFileRequest) String 

func (x *DeleteFileRequest) String() string

type DeleteFileResponse 

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

Response to `DeleteFileRequest`. Empty payload.

func (*DeleteFileResponse) Descriptor deprecated 

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

Deprecated: Use DeleteFileResponse.ProtoReflect.Descriptor instead.

func (*DeleteFileResponse) ProtoMessage 

func (*DeleteFileResponse) ProtoMessage()

func (*DeleteFileResponse) ProtoReflect 

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

func (*DeleteFileResponse) Reset 

func (x *DeleteFileResponse) Reset()

func (*DeleteFileResponse) String 

func (x *DeleteFileResponse) String() string

type File 

type File struct {
	Id         string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`                                   // ID of file, generated randomly by Trinsic on upload
	UploaderId string `protobuf:"bytes,2,opt,name=uploader_id,json=uploaderId,proto3" json:"uploader_id,omitempty"` // Wallet ID of uploader
	Size       uint32 `protobuf:"varint,3,opt,name=size,proto3" json:"size,omitempty"`                              // Size, in bytes, of file
	MimeType   string `protobuf:"bytes,4,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`       // Uploader-provided MIME type of file
	Uploaded   string `protobuf:"bytes,5,opt,name=uploaded,proto3" json:"uploaded,omitempty"`                       // ISO 8601 timestamp of when file was uploaded to Trinsic
	Url        string `protobuf:"bytes,6,opt,name=url,proto3" json:"url,omitempty"`                                 // CDN URL of file
	// contains filtered or unexported fields
}

Contains information about a file stored in Trinsic's CDN

func (*File) Descriptor deprecated 

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

Deprecated: Use File.ProtoReflect.Descriptor instead.

func (*File) GetId 

func (x *File) GetId() string

func (*File) GetMimeType 

func (x *File) GetMimeType() string

func (*File) GetSize 

func (x *File) GetSize() uint32

func (*File) GetUploaded 

func (x *File) GetUploaded() string

func (*File) GetUploaderId 

func (x *File) GetUploaderId() string

func (*File) GetUrl 

func (x *File) GetUrl() string

func (*File) ProtoMessage 

func (*File) ProtoMessage()

func (*File) ProtoReflect 

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

func (*File) Reset 

func (x *File) Reset()

func (*File) String 

func (x *File) String() string

type FileManagementClient 

type FileManagementClient interface {
	// Upload a file to Trinsic's CDN
	UploadFile(ctx context.Context, in *UploadFileRequest, opts ...grpc.CallOption) (*UploadFileResponse, error)
	// Fetch information about a file by its ID
	GetFile(ctx context.Context, in *GetFileRequest, opts ...grpc.CallOption) (*GetFileResponse, error)
	// Delete a file by its ID
	DeleteFile(ctx context.Context, in *DeleteFileRequest, opts ...grpc.CallOption) (*DeleteFileResponse, error)
	// List files the calling account has uploaded
	ListFiles(ctx context.Context, in *ListFilesRequest, opts ...grpc.CallOption) (*ListFilesResponse, error)
	// Get statistics about files uploaded by the calling account
	GetStorageStats(ctx context.Context, in *GetStorageStatsRequest, opts ...grpc.CallOption) (*GetStorageStatsResponse, error)
}

FileManagementClient is the client API for FileManagement 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 NewFileManagementClient 

func NewFileManagementClient(cc grpc.ClientConnInterface) FileManagementClient

type FileManagementServer 

type FileManagementServer interface {
	// Upload a file to Trinsic's CDN
	UploadFile(context.Context, *UploadFileRequest) (*UploadFileResponse, error)
	// Fetch information about a file by its ID
	GetFile(context.Context, *GetFileRequest) (*GetFileResponse, error)
	// Delete a file by its ID
	DeleteFile(context.Context, *DeleteFileRequest) (*DeleteFileResponse, error)
	// List files the calling account has uploaded
	ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)
	// Get statistics about files uploaded by the calling account
	GetStorageStats(context.Context, *GetStorageStatsRequest) (*GetStorageStatsResponse, error)
	// contains filtered or unexported methods
}

FileManagementServer is the server API for FileManagement service. All implementations must embed UnimplementedFileManagementServer for forward compatibility

type GetFileRequest 

type GetFileRequest struct {
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // ID of file to fetch
	// contains filtered or unexported fields
}

Request to fetch information about a stored file

func (*GetFileRequest) Descriptor deprecated 

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

Deprecated: Use GetFileRequest.ProtoReflect.Descriptor instead.

func (*GetFileRequest) GetId 

func (x *GetFileRequest) GetId() string

func (*GetFileRequest) ProtoMessage 

func (*GetFileRequest) ProtoMessage()

func (*GetFileRequest) ProtoReflect 

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

func (*GetFileRequest) Reset 

func (x *GetFileRequest) Reset()

func (*GetFileRequest) String 

func (x *GetFileRequest) String() string

type GetFileResponse 

type GetFileResponse struct {
	File *File `protobuf:"bytes,1,opt,name=file,proto3" json:"file,omitempty"` // File specified by `id` parameter of `GetFileRequest`.
	// contains filtered or unexported fields
}

Response to `GetFileRequest`

func (*GetFileResponse) Descriptor deprecated 

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

Deprecated: Use GetFileResponse.ProtoReflect.Descriptor instead.

func (*GetFileResponse) GetFile 

func (x *GetFileResponse) GetFile() *File

func (*GetFileResponse) ProtoMessage 

func (*GetFileResponse) ProtoMessage()

func (*GetFileResponse) ProtoReflect 

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

func (*GetFileResponse) Reset 

func (x *GetFileResponse) Reset()

func (*GetFileResponse) String 

func (x *GetFileResponse) String() string

type GetStorageStatsRequest 

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

Request to get statistics about files uploaded by this account

func (*GetStorageStatsRequest) Descriptor deprecated 

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

Deprecated: Use GetStorageStatsRequest.ProtoReflect.Descriptor instead.

func (*GetStorageStatsRequest) ProtoMessage 

func (*GetStorageStatsRequest) ProtoMessage()

func (*GetStorageStatsRequest) ProtoReflect 

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

func (*GetStorageStatsRequest) Reset 

func (x *GetStorageStatsRequest) Reset()

func (*GetStorageStatsRequest) String 

func (x *GetStorageStatsRequest) String() string

type GetStorageStatsResponse 

type GetStorageStatsResponse struct {
	Stats *StorageStats `protobuf:"bytes,1,opt,name=stats,proto3" json:"stats,omitempty"` // Statistics about files uploaded by the calling account
	// contains filtered or unexported fields
}

Response to `GetStorageStatsRequest`

func (*GetStorageStatsResponse) Descriptor deprecated 

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

Deprecated: Use GetStorageStatsResponse.ProtoReflect.Descriptor instead.

func (*GetStorageStatsResponse) GetStats 

func (x *GetStorageStatsResponse) GetStats() *StorageStats

func (*GetStorageStatsResponse) ProtoMessage 

func (*GetStorageStatsResponse) ProtoMessage()

func (*GetStorageStatsResponse) ProtoReflect 

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

func (*GetStorageStatsResponse) Reset 

func (x *GetStorageStatsResponse) Reset()

func (*GetStorageStatsResponse) String 

func (x *GetStorageStatsResponse) String() string

type ListFilesRequest 

type ListFilesRequest struct {

	// Query to search with. If not specified, will return the most recent 100 files.
	Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"`
	// Token provided by previous `ListFilesRequest`
	// if more data is available for query
	ContinuationToken string `protobuf:"bytes,2,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

Request to list files

func (*ListFilesRequest) Descriptor deprecated 

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

Deprecated: Use ListFilesRequest.ProtoReflect.Descriptor instead.

func (*ListFilesRequest) GetContinuationToken 

func (x *ListFilesRequest) GetContinuationToken() string

func (*ListFilesRequest) GetQuery 

func (x *ListFilesRequest) GetQuery() string

func (*ListFilesRequest) ProtoMessage 

func (*ListFilesRequest) ProtoMessage()

func (*ListFilesRequest) ProtoReflect 

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

func (*ListFilesRequest) Reset 

func (x *ListFilesRequest) Reset()

func (*ListFilesRequest) String 

func (x *ListFilesRequest) String() string

type ListFilesResponse 

type ListFilesResponse struct {

	// Files found by query
	Files []*File `protobuf:"bytes,1,rep,name=files,proto3" json:"files,omitempty"`
	// Whether more results are available for this query via `continuation_token`
	HasMoreResults bool `protobuf:"varint,2,opt,name=has_more_results,json=hasMoreResults,proto3" json:"has_more_results,omitempty"`
	// Token to fetch next set of results via `ListFilesRequest`
	ContinuationToken string `protobuf:"bytes,3,opt,name=continuation_token,json=continuationToken,proto3" json:"continuation_token,omitempty"`
	// contains filtered or unexported fields
}

Response to `ListFilesRequest`

func (*ListFilesResponse) Descriptor deprecated 

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

Deprecated: Use ListFilesResponse.ProtoReflect.Descriptor instead.

func (*ListFilesResponse) GetContinuationToken 

func (x *ListFilesResponse) GetContinuationToken() string

func (*ListFilesResponse) GetFiles 

func (x *ListFilesResponse) GetFiles() []*File

func (*ListFilesResponse) GetHasMoreResults 

func (x *ListFilesResponse) GetHasMoreResults() bool

func (*ListFilesResponse) ProtoMessage 

func (*ListFilesResponse) ProtoMessage()

func (*ListFilesResponse) ProtoReflect 

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

func (*ListFilesResponse) Reset 

func (x *ListFilesResponse) Reset()

func (*ListFilesResponse) String 

func (x *ListFilesResponse) String() string

type StorageStats 

type StorageStats struct {
	NumFiles  uint32 `protobuf:"varint,1,opt,name=num_files,json=numFiles,proto3" json:"num_files,omitempty"`    // Number of files uploaded by this account
	TotalSize uint64 `protobuf:"varint,2,opt,name=total_size,json=totalSize,proto3" json:"total_size,omitempty"` // Sum total size of all files, in bytes
	// contains filtered or unexported fields
}

Represents aggregate statistics of all files uploaded by a single issuer

func (*StorageStats) Descriptor deprecated 

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

Deprecated: Use StorageStats.ProtoReflect.Descriptor instead.

func (*StorageStats) GetNumFiles 

func (x *StorageStats) GetNumFiles() uint32

func (*StorageStats) GetTotalSize 

func (x *StorageStats) GetTotalSize() uint64

func (*StorageStats) ProtoMessage 

func (*StorageStats) ProtoMessage()

func (*StorageStats) ProtoReflect 

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

func (*StorageStats) Reset 

func (x *StorageStats) Reset()

func (*StorageStats) String 

func (x *StorageStats) String() string

type UnimplementedFileManagementServer 

type UnimplementedFileManagementServer struct {
}

UnimplementedFileManagementServer must be embedded to have forward compatible implementations.

func (UnimplementedFileManagementServer) DeleteFile 

func (UnimplementedFileManagementServer) DeleteFile(context.Context, *DeleteFileRequest) (*DeleteFileResponse, error)

func (UnimplementedFileManagementServer) GetFile 

func (UnimplementedFileManagementServer) GetFile(context.Context, *GetFileRequest) (*GetFileResponse, error)

func (UnimplementedFileManagementServer) GetStorageStats 

func (UnimplementedFileManagementServer) GetStorageStats(context.Context, *GetStorageStatsRequest) (*GetStorageStatsResponse, error)

func (UnimplementedFileManagementServer) ListFiles 

func (UnimplementedFileManagementServer) ListFiles(context.Context, *ListFilesRequest) (*ListFilesResponse, error)

func (UnimplementedFileManagementServer) UploadFile 

func (UnimplementedFileManagementServer) UploadFile(context.Context, *UploadFileRequest) (*UploadFileResponse, error)

type UnsafeFileManagementServer 

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

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

type UploadFileRequest 

type UploadFileRequest struct {

	// Raw content of file
	Contents []byte `protobuf:"bytes,1,opt,name=contents,proto3" json:"contents,omitempty"`
	// MIME type describing file contents
	MimeType string `protobuf:"bytes,2,opt,name=mime_type,json=mimeType,proto3" json:"mime_type,omitempty"`
	// contains filtered or unexported fields
}

Request to upload a file to Trinsic's CDN

func (*UploadFileRequest) Descriptor deprecated 

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

Deprecated: Use UploadFileRequest.ProtoReflect.Descriptor instead.

func (*UploadFileRequest) GetContents 

func (x *UploadFileRequest) GetContents() []byte

func (*UploadFileRequest) GetMimeType 

func (x *UploadFileRequest) GetMimeType() string

func (*UploadFileRequest) ProtoMessage 

func (*UploadFileRequest) ProtoMessage()

func (*UploadFileRequest) ProtoReflect 

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

func (*UploadFileRequest) Reset 

func (x *UploadFileRequest) Reset()

func (*UploadFileRequest) String 

func (x *UploadFileRequest) String() string

type UploadFileResponse 

type UploadFileResponse struct {
	UploadedFile *File `protobuf:"bytes,1,opt,name=uploaded_file,json=uploadedFile,proto3" json:"uploaded_file,omitempty"` // Information about newly-uploaded file
	// contains filtered or unexported fields
}

Response to `UploadFileRequest`

func (*UploadFileResponse) Descriptor deprecated 

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

Deprecated: Use UploadFileResponse.ProtoReflect.Descriptor instead.

func (*UploadFileResponse) GetUploadedFile 

func (x *UploadFileResponse) GetUploadedFile() *File

func (*UploadFileResponse) ProtoMessage 

func (*UploadFileResponse) ProtoMessage()

func (*UploadFileResponse) ProtoReflect 

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

func (*UploadFileResponse) Reset 

func (x *UploadFileResponse) Reset()

func (*UploadFileResponse) String 

func (x *UploadFileResponse) String() string

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.