storageconnect

package
v0.0.0-...-3911e28 Latest Latest
Warning

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

Go to latest
Published: Jul 12, 2023 License: MIT Imports: 6 Imported by: 1

Documentation

Index

Constants

View Source
const (
	// ServiceCreateBucketProcedure is the fully-qualified name of the Service's CreateBucket RPC.
	ServiceCreateBucketProcedure = "/api.v1.storage.Service/CreateBucket"
	// ServiceGetBucketProcedure is the fully-qualified name of the Service's GetBucket RPC.
	ServiceGetBucketProcedure = "/api.v1.storage.Service/GetBucket"
	// ServiceListBucketsProcedure is the fully-qualified name of the Service's ListBuckets RPC.
	ServiceListBucketsProcedure = "/api.v1.storage.Service/ListBuckets"
	// ServiceDeleteBucketProcedure is the fully-qualified name of the Service's DeleteBucket RPC.
	ServiceDeleteBucketProcedure = "/api.v1.storage.Service/DeleteBucket"
	// ServiceUnlinkBucketProcedure is the fully-qualified name of the Service's UnlinkBucket RPC.
	ServiceUnlinkBucketProcedure = "/api.v1.storage.Service/UnlinkBucket"
	// ServiceGetObjectProcedure is the fully-qualified name of the Service's GetObject RPC.
	ServiceGetObjectProcedure = "/api.v1.storage.Service/GetObject"
	// ServiceListObjectsProcedure is the fully-qualified name of the Service's ListObjects RPC.
	ServiceListObjectsProcedure = "/api.v1.storage.Service/ListObjects"
	// ServiceDeleteObjectProcedure is the fully-qualified name of the Service's DeleteObject RPC.
	ServiceDeleteObjectProcedure = "/api.v1.storage.Service/DeleteObject"
	// ServiceCopyObjectProcedure is the fully-qualified name of the Service's CopyObject RPC.
	ServiceCopyObjectProcedure = "/api.v1.storage.Service/CopyObject"
	// ServiceUploadObjectProcedure is the fully-qualified name of the Service's UploadObject RPC.
	ServiceUploadObjectProcedure = "/api.v1.storage.Service/UploadObject"
	// ServiceDownloadObjectProcedure is the fully-qualified name of the Service's DownloadObject RPC.
	ServiceDownloadObjectProcedure = "/api.v1.storage.Service/DownloadObject"
	// ServiceCreateProviderProcedure is the fully-qualified name of the Service's CreateProvider RPC.
	ServiceCreateProviderProcedure = "/api.v1.storage.Service/CreateProvider"
	// ServiceDeleteProviderProcedure is the fully-qualified name of the Service's DeleteProvider RPC.
	ServiceDeleteProviderProcedure = "/api.v1.storage.Service/DeleteProvider"
	// ServiceGetProviderProcedure is the fully-qualified name of the Service's GetProvider RPC.
	ServiceGetProviderProcedure = "/api.v1.storage.Service/GetProvider"
	// ServiceListProvidersProcedure is the fully-qualified name of the Service's ListProviders RPC.
	ServiceListProvidersProcedure = "/api.v1.storage.Service/ListProviders"
	// ServiceLookupProviderProcedure is the fully-qualified name of the Service's LookupProvider RPC.
	ServiceLookupProviderProcedure = "/api.v1.storage.Service/LookupProvider"
)

These constants are the fully-qualified names of the RPCs defined in this package. They're exposed at runtime as Spec.Procedure and as the final two segments of the HTTP route.

Note that these are different from the fully-qualified method names used by google.golang.org/protobuf/reflect/protoreflect. To convert from these constants to reflection-formatted method names, remove the leading slash and convert the remaining slash to a period.

View Source
const (
	// ServiceName is the fully-qualified name of the Service service.
	ServiceName = "api.v1.storage.Service"
)

Variables

This section is empty.

Functions

func NewServiceHandler

func NewServiceHandler(svc ServiceHandler, opts ...connect_go.HandlerOption) (string, http.Handler)

NewServiceHandler builds an HTTP handler from the service implementation. It returns the path on which to mount the handler and the handler itself.

By default, handlers support the Connect, gRPC, and gRPC-Web protocols with the binary Protobuf and JSON codecs. They also support gzip compression.

Types

type ServiceClient

type ServiceClient interface {
	CreateBucket(context.Context, *connect_go.Request[storage.CreateBucketRequest]) (*connect_go.Response[storage.CreateBucketResponse], error)
	GetBucket(context.Context, *connect_go.Request[storage.GetBucketRequest]) (*connect_go.Response[storage.GetBucketResponse], error)
	ListBuckets(context.Context, *connect_go.Request[storage.ListBucketsRequest]) (*connect_go.Response[storage.ListBucketsResponse], error)
	DeleteBucket(context.Context, *connect_go.Request[storage.DeleteBucketRequest]) (*connect_go.Response[storage.DeleteBucketResponse], error)
	UnlinkBucket(context.Context, *connect_go.Request[storage.UnlinkBucketRequest]) (*connect_go.Response[storage.UnlinkBucketResponse], error)
	GetObject(context.Context, *connect_go.Request[storage.GetObjectRequest]) (*connect_go.Response[storage.GetObjectResponse], error)
	ListObjects(context.Context, *connect_go.Request[storage.ListObjectsRequest]) (*connect_go.Response[storage.ListObjectsResponse], error)
	DeleteObject(context.Context, *connect_go.Request[storage.DeleteObjectRequest]) (*connect_go.Response[storage.DeleteObjectResponse], error)
	CopyObject(context.Context, *connect_go.Request[storage.CopyObjectRequest]) (*connect_go.Response[storage.CopyObjectResponse], error)
	UploadObject(context.Context) *connect_go.ClientStreamForClient[storage.UploadObjectRequest, storage.UploadObjectResponse]
	DownloadObject(context.Context, *connect_go.Request[storage.DownloadObjectRequest]) (*connect_go.ServerStreamForClient[storage.DownloadObjectResponse], error)
	CreateProvider(context.Context, *connect_go.Request[storage.CreateProviderRequest]) (*connect_go.Response[storage.CreateProviderResponse], error)
	DeleteProvider(context.Context, *connect_go.Request[storage.DeleteProviderRequest]) (*connect_go.Response[storage.DeleteProviderResponse], error)
	GetProvider(context.Context, *connect_go.Request[storage.GetProviderRequest]) (*connect_go.Response[storage.GetProviderResponse], error)
	ListProviders(context.Context, *connect_go.Request[storage.ListProvidersRequest]) (*connect_go.Response[storage.ListProvidersResponse], error)
	LookupProvider(context.Context, *connect_go.Request[storage.LookupProviderRequest]) (*connect_go.Response[storage.LookupProviderResponse], error)
}

ServiceClient is a client for the api.v1.storage.Service service.

func NewServiceClient

func NewServiceClient(httpClient connect_go.HTTPClient, baseURL string, opts ...connect_go.ClientOption) ServiceClient

NewServiceClient constructs a client for the api.v1.storage.Service service. By default, it uses the Connect protocol with the binary Protobuf Codec, asks for gzipped responses, and sends uncompressed requests. To use the gRPC or gRPC-Web protocols, supply the connect.WithGRPC() or connect.WithGRPCWeb() options.

The URL supplied here should be the base URL for the Connect or gRPC server (for example, http://api.acme.com or https://acme.com/grpc).

type ServiceHandler

type ServiceHandler interface {
	CreateBucket(context.Context, *connect_go.Request[storage.CreateBucketRequest]) (*connect_go.Response[storage.CreateBucketResponse], error)
	GetBucket(context.Context, *connect_go.Request[storage.GetBucketRequest]) (*connect_go.Response[storage.GetBucketResponse], error)
	ListBuckets(context.Context, *connect_go.Request[storage.ListBucketsRequest]) (*connect_go.Response[storage.ListBucketsResponse], error)
	DeleteBucket(context.Context, *connect_go.Request[storage.DeleteBucketRequest]) (*connect_go.Response[storage.DeleteBucketResponse], error)
	UnlinkBucket(context.Context, *connect_go.Request[storage.UnlinkBucketRequest]) (*connect_go.Response[storage.UnlinkBucketResponse], error)
	GetObject(context.Context, *connect_go.Request[storage.GetObjectRequest]) (*connect_go.Response[storage.GetObjectResponse], error)
	ListObjects(context.Context, *connect_go.Request[storage.ListObjectsRequest]) (*connect_go.Response[storage.ListObjectsResponse], error)
	DeleteObject(context.Context, *connect_go.Request[storage.DeleteObjectRequest]) (*connect_go.Response[storage.DeleteObjectResponse], error)
	CopyObject(context.Context, *connect_go.Request[storage.CopyObjectRequest]) (*connect_go.Response[storage.CopyObjectResponse], error)
	UploadObject(context.Context, *connect_go.ClientStream[storage.UploadObjectRequest]) (*connect_go.Response[storage.UploadObjectResponse], error)
	DownloadObject(context.Context, *connect_go.Request[storage.DownloadObjectRequest], *connect_go.ServerStream[storage.DownloadObjectResponse]) error
	CreateProvider(context.Context, *connect_go.Request[storage.CreateProviderRequest]) (*connect_go.Response[storage.CreateProviderResponse], error)
	DeleteProvider(context.Context, *connect_go.Request[storage.DeleteProviderRequest]) (*connect_go.Response[storage.DeleteProviderResponse], error)
	GetProvider(context.Context, *connect_go.Request[storage.GetProviderRequest]) (*connect_go.Response[storage.GetProviderResponse], error)
	ListProviders(context.Context, *connect_go.Request[storage.ListProvidersRequest]) (*connect_go.Response[storage.ListProvidersResponse], error)
	LookupProvider(context.Context, *connect_go.Request[storage.LookupProviderRequest]) (*connect_go.Response[storage.LookupProviderResponse], error)
}

ServiceHandler is an implementation of the api.v1.storage.Service service.

type UnimplementedServiceHandler

type UnimplementedServiceHandler struct{}

UnimplementedServiceHandler returns CodeUnimplemented from all methods.

Jump to

Keyboard shortcuts

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