Documentation
¶
Index ¶
- Constants
- func NewAnnotationServiceHandler(svc AnnotationServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
- type AnnotationServiceClient
- type AnnotationServiceHandler
- type UnimplementedAnnotationServiceHandler
- func (UnimplementedAnnotationServiceHandler) AddAnnotation(context.Context, *connect.Request[v1.AddAnnotationRequest]) (*connect.Response[v1.AddAnnotationResponse], error)
- func (UnimplementedAnnotationServiceHandler) ListAnnotations(context.Context, *connect.Request[v1.ListAnnotationsRequest]) (*connect.Response[v1.ListAnnotationsResponse], error)
- func (UnimplementedAnnotationServiceHandler) RemoveAnnotation(context.Context, *connect.Request[v1.RemoveAnnotationRequest]) (*connect.Response[v1.RemoveAnnotationResponse], error)
- func (UnimplementedAnnotationServiceHandler) UpdateAnnotationVisibility(context.Context, *connect.Request[v1.UpdateAnnotationVisibilityRequest]) (*connect.Response[v1.UpdateAnnotationVisibilityResponse], error)
Constants ¶
const ( // AnnotationServiceAddAnnotationProcedure is the fully-qualified name of the AnnotationService's // AddAnnotation RPC. AnnotationServiceAddAnnotationProcedure = "/cloudstack.management.annotation.v1.AnnotationService/AddAnnotation" // AnnotationServiceListAnnotationsProcedure is the fully-qualified name of the AnnotationService's // ListAnnotations RPC. AnnotationServiceListAnnotationsProcedure = "/cloudstack.management.annotation.v1.AnnotationService/ListAnnotations" // AnnotationServiceRemoveAnnotationProcedure is the fully-qualified name of the AnnotationService's // RemoveAnnotation RPC. AnnotationServiceRemoveAnnotationProcedure = "/cloudstack.management.annotation.v1.AnnotationService/RemoveAnnotation" // AnnotationServiceUpdateAnnotationVisibilityProcedure is the fully-qualified name of the // AnnotationService's UpdateAnnotationVisibility RPC. AnnotationServiceUpdateAnnotationVisibilityProcedure = "/cloudstack.management.annotation.v1.AnnotationService/UpdateAnnotationVisibility" )
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 (
// AnnotationServiceName is the fully-qualified name of the AnnotationService service.
AnnotationServiceName = "cloudstack.management.annotation.v1.AnnotationService"
)
Variables ¶
This section is empty.
Functions ¶
func NewAnnotationServiceHandler ¶
func NewAnnotationServiceHandler(svc AnnotationServiceHandler, opts ...connect.HandlerOption) (string, http.Handler)
NewAnnotationServiceHandler 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 AnnotationServiceClient ¶
type AnnotationServiceClient interface {
// AddAnnotation add an annotation.
AddAnnotation(context.Context, *connect.Request[v1.AddAnnotationRequest]) (*connect.Response[v1.AddAnnotationResponse], error)
// ListAnnotations Lists annotations.
ListAnnotations(context.Context, *connect.Request[v1.ListAnnotationsRequest]) (*connect.Response[v1.ListAnnotationsResponse], error)
// RemoveAnnotation remove an annotation.
RemoveAnnotation(context.Context, *connect.Request[v1.RemoveAnnotationRequest]) (*connect.Response[v1.RemoveAnnotationResponse], error)
// UpdateAnnotationVisibility update an annotation visibility.
UpdateAnnotationVisibility(context.Context, *connect.Request[v1.UpdateAnnotationVisibilityRequest]) (*connect.Response[v1.UpdateAnnotationVisibilityResponse], error)
}
AnnotationServiceClient is a client for the cloudstack.management.annotation.v1.AnnotationService service.
func NewAnnotationServiceClient ¶
func NewAnnotationServiceClient(httpClient connect.HTTPClient, baseURL string, opts ...connect.ClientOption) AnnotationServiceClient
NewAnnotationServiceClient constructs a client for the cloudstack.management.annotation.v1.AnnotationService 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 AnnotationServiceHandler ¶
type AnnotationServiceHandler interface {
// AddAnnotation add an annotation.
AddAnnotation(context.Context, *connect.Request[v1.AddAnnotationRequest]) (*connect.Response[v1.AddAnnotationResponse], error)
// ListAnnotations Lists annotations.
ListAnnotations(context.Context, *connect.Request[v1.ListAnnotationsRequest]) (*connect.Response[v1.ListAnnotationsResponse], error)
// RemoveAnnotation remove an annotation.
RemoveAnnotation(context.Context, *connect.Request[v1.RemoveAnnotationRequest]) (*connect.Response[v1.RemoveAnnotationResponse], error)
// UpdateAnnotationVisibility update an annotation visibility.
UpdateAnnotationVisibility(context.Context, *connect.Request[v1.UpdateAnnotationVisibilityRequest]) (*connect.Response[v1.UpdateAnnotationVisibilityResponse], error)
}
AnnotationServiceHandler is an implementation of the cloudstack.management.annotation.v1.AnnotationService service.
type UnimplementedAnnotationServiceHandler ¶
type UnimplementedAnnotationServiceHandler struct{}
UnimplementedAnnotationServiceHandler returns CodeUnimplemented from all methods.
func (UnimplementedAnnotationServiceHandler) AddAnnotation ¶
func (UnimplementedAnnotationServiceHandler) AddAnnotation(context.Context, *connect.Request[v1.AddAnnotationRequest]) (*connect.Response[v1.AddAnnotationResponse], error)
func (UnimplementedAnnotationServiceHandler) ListAnnotations ¶
func (UnimplementedAnnotationServiceHandler) ListAnnotations(context.Context, *connect.Request[v1.ListAnnotationsRequest]) (*connect.Response[v1.ListAnnotationsResponse], error)
func (UnimplementedAnnotationServiceHandler) RemoveAnnotation ¶
func (UnimplementedAnnotationServiceHandler) RemoveAnnotation(context.Context, *connect.Request[v1.RemoveAnnotationRequest]) (*connect.Response[v1.RemoveAnnotationResponse], error)
func (UnimplementedAnnotationServiceHandler) UpdateAnnotationVisibility ¶
func (UnimplementedAnnotationServiceHandler) UpdateAnnotationVisibility(context.Context, *connect.Request[v1.UpdateAnnotationVisibilityRequest]) (*connect.Response[v1.UpdateAnnotationVisibilityResponse], error)
Source Files