Documentation
¶
Index ¶
- Constants
- func NewServiceHandler(svc ServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type ServiceClient
- type ServiceHandler
- type UnimplementedServiceHandler
- func (UnimplementedServiceHandler) GetLicenseInfo(context.Context, *connect.Request[settings.GetLicenseInfoRequest]) (*connect.Response[settings.GetLicenseInfoResponse], error)
- func (UnimplementedServiceHandler) GetSettings(context.Context, *connect.Request[settings.GetSettingsRequest]) (*connect.Response[settings.GetSettingsResponse], error)
- func (UnimplementedServiceHandler) UpdateSettings(context.Context, *connect.Request[settings.UpdateSettingsRequest]) (*connect.Response[settings.UpdateSettingsResponse], error)
Constants ¶
const ( // ServiceGetSettingsProcedure is the fully-qualified name of the Service's GetSettings RPC. ServiceGetSettingsProcedure = "/api.v1.project.settings.Service/GetSettings" // ServiceUpdateSettingsProcedure is the fully-qualified name of the Service's UpdateSettings RPC. ServiceUpdateSettingsProcedure = "/api.v1.project.settings.Service/UpdateSettings" // ServiceGetLicenseInfoProcedure is the fully-qualified name of the Service's GetLicenseInfo RPC. ServiceGetLicenseInfoProcedure = "/api.v1.project.settings.Service/GetLicenseInfo" )
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.
const (
// ServiceName is the fully-qualified name of the Service service.
ServiceName = "api.v1.project.settings.Service"
)
Variables ¶
This section is empty.
Functions ¶
func NewServiceHandler ¶
func NewServiceHandler(svc ServiceHandler, opts ...connect.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 {
// Gets the users settings for the current project.
GetSettings(context.Context, *connect.Request[settings.GetSettingsRequest]) (*connect.Response[settings.GetSettingsResponse], error)
// Sets the users settings for the current project.
UpdateSettings(context.Context, *connect.Request[settings.UpdateSettingsRequest]) (*connect.Response[settings.UpdateSettingsResponse], error)
// Get License Information.
GetLicenseInfo(context.Context, *connect.Request[settings.GetLicenseInfoRequest]) (*connect.Response[settings.GetLicenseInfoResponse], error)
}
ServiceClient is a client for the api.v1.project.settings.Service service.
func NewServiceClient ¶
func NewServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) ServiceClient
NewServiceClient constructs a client for the api.v1.project.settings.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 {
// Gets the users settings for the current project.
GetSettings(context.Context, *connect.Request[settings.GetSettingsRequest]) (*connect.Response[settings.GetSettingsResponse], error)
// Sets the users settings for the current project.
UpdateSettings(context.Context, *connect.Request[settings.UpdateSettingsRequest]) (*connect.Response[settings.UpdateSettingsResponse], error)
// Get License Information.
GetLicenseInfo(context.Context, *connect.Request[settings.GetLicenseInfoRequest]) (*connect.Response[settings.GetLicenseInfoResponse], error)
}
ServiceHandler is an implementation of the api.v1.project.settings.Service service.
type UnimplementedServiceHandler ¶
type UnimplementedServiceHandler struct{}
UnimplementedServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedServiceHandler) GetLicenseInfo ¶
func (UnimplementedServiceHandler) GetLicenseInfo(context.Context, *connect.Request[settings.GetLicenseInfoRequest]) (*connect.Response[settings.GetLicenseInfoResponse], error)
func (UnimplementedServiceHandler) GetSettings ¶
func (UnimplementedServiceHandler) GetSettings(context.Context, *connect.Request[settings.GetSettingsRequest]) (*connect.Response[settings.GetSettingsResponse], error)
func (UnimplementedServiceHandler) UpdateSettings ¶
func (UnimplementedServiceHandler) UpdateSettings(context.Context, *connect.Request[settings.UpdateSettingsRequest]) (*connect.Response[settings.UpdateSettingsResponse], error)
Source Files