v1alpha1

package
v0.0.0-...-49e881a Latest Latest
Warning

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

 Go to latest Published: Dec 2, 2025 License: MPL-2.0 Imports: 21 Imported by: 4

Documentation

Overview

Package v1alpha1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	MicroVM_CreateMicroVM_FullMethodName      = "/microvm.services.api.v1alpha1.MicroVM/CreateMicroVM"
	MicroVM_DeleteMicroVM_FullMethodName      = "/microvm.services.api.v1alpha1.MicroVM/DeleteMicroVM"
	MicroVM_GetMicroVM_FullMethodName         = "/microvm.services.api.v1alpha1.MicroVM/GetMicroVM"
	MicroVM_ListMicroVMs_FullMethodName       = "/microvm.services.api.v1alpha1.MicroVM/ListMicroVMs"
	MicroVM_ListMicroVMsStream_FullMethodName = "/microvm.services.api.v1alpha1.MicroVM/ListMicroVMsStream"
)

Variables

View Source 
var File_services_microvm_v1alpha1_microvms_proto protoreflect.FileDescriptor
View Source 
var MicroVM_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "microvm.services.api.v1alpha1.MicroVM",
	HandlerType: (*MicroVMServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "CreateMicroVM",
			Handler:    _MicroVM_CreateMicroVM_Handler,
		},
		{
			MethodName: "DeleteMicroVM",
			Handler:    _MicroVM_DeleteMicroVM_Handler,
		},
		{
			MethodName: "GetMicroVM",
			Handler:    _MicroVM_GetMicroVM_Handler,
		},
		{
			MethodName: "ListMicroVMs",
			Handler:    _MicroVM_ListMicroVMs_Handler,
		},
	},
	Streams: []grpc.StreamDesc{
		{
			StreamName:    "ListMicroVMsStream",
			Handler:       _MicroVM_ListMicroVMsStream_Handler,
			ServerStreams: true,
		},
	},
	Metadata: "services/microvm/v1alpha1/microvms.proto",
}

MicroVM_ServiceDesc is the grpc.ServiceDesc for MicroVM service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

Functions

func RegisterMicroVMHandler 

func RegisterMicroVMHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterMicroVMHandler registers the http handlers for service MicroVM to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterMicroVMHandlerClient 

func RegisterMicroVMHandlerClient(ctx context.Context, mux *runtime.ServeMux, client MicroVMClient) error

RegisterMicroVMHandlerClient registers the http handlers for service MicroVM to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "MicroVMClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "MicroVMClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "MicroVMClient" to call the correct interceptors. This client ignores the HTTP middlewares.

func RegisterMicroVMHandlerFromEndpoint 

func RegisterMicroVMHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterMicroVMHandlerFromEndpoint is same as RegisterMicroVMHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterMicroVMHandlerServer 

func RegisterMicroVMHandlerServer(ctx context.Context, mux *runtime.ServeMux, server MicroVMServer) error

RegisterMicroVMHandlerServer registers the http handlers for service MicroVM to "mux". UnaryRPC :call MicroVMServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterMicroVMHandlerFromEndpoint instead. GRPC interceptors will not work for this type of registration. To use interceptors, you must use the "runtime.WithMiddlewares" option in the "runtime.NewServeMux" call.

func RegisterMicroVMServer 

func RegisterMicroVMServer(s grpc.ServiceRegistrar, srv MicroVMServer)

Types

type CreateMicroVMRequest 

type CreateMicroVMRequest struct {
	Microvm  *types.MicroVMSpec    `protobuf:"bytes,1,opt,name=microvm,proto3" json:"microvm,omitempty"`
	Metadata map[string]*anypb.Any `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*CreateMicroVMRequest) Descriptor deprecated 

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

Deprecated: Use CreateMicroVMRequest.ProtoReflect.Descriptor instead.

func (*CreateMicroVMRequest) GetMetadata 

func (x *CreateMicroVMRequest) GetMetadata() map[string]*anypb.Any

func (*CreateMicroVMRequest) GetMicrovm 

func (x *CreateMicroVMRequest) GetMicrovm() *types.MicroVMSpec

func (*CreateMicroVMRequest) ProtoMessage 

func (*CreateMicroVMRequest) ProtoMessage()

func (*CreateMicroVMRequest) ProtoReflect 

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

func (*CreateMicroVMRequest) Reset 

func (x *CreateMicroVMRequest) Reset()

func (*CreateMicroVMRequest) String 

func (x *CreateMicroVMRequest) String() string

type CreateMicroVMResponse 

type CreateMicroVMResponse struct {
	Microvm *types.MicroVM `protobuf:"bytes,1,opt,name=microvm,proto3" json:"microvm,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateMicroVMResponse) Descriptor deprecated 

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

Deprecated: Use CreateMicroVMResponse.ProtoReflect.Descriptor instead.

func (*CreateMicroVMResponse) GetMicrovm 

func (x *CreateMicroVMResponse) GetMicrovm() *types.MicroVM

func (*CreateMicroVMResponse) ProtoMessage 

func (*CreateMicroVMResponse) ProtoMessage()

func (*CreateMicroVMResponse) ProtoReflect 

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

func (*CreateMicroVMResponse) Reset 

func (x *CreateMicroVMResponse) Reset()

func (*CreateMicroVMResponse) String 

func (x *CreateMicroVMResponse) String() string

type DeleteMicroVMRequest 

type DeleteMicroVMRequest struct {
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// contains filtered or unexported fields
}

func (*DeleteMicroVMRequest) Descriptor deprecated 

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

Deprecated: Use DeleteMicroVMRequest.ProtoReflect.Descriptor instead.

func (*DeleteMicroVMRequest) GetUid 

func (x *DeleteMicroVMRequest) GetUid() string

func (*DeleteMicroVMRequest) ProtoMessage 

func (*DeleteMicroVMRequest) ProtoMessage()

func (*DeleteMicroVMRequest) ProtoReflect 

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

func (*DeleteMicroVMRequest) Reset 

func (x *DeleteMicroVMRequest) Reset()

func (*DeleteMicroVMRequest) String 

func (x *DeleteMicroVMRequest) String() string

type GetMicroVMRequest 

type GetMicroVMRequest struct {
	Uid string `protobuf:"bytes,1,opt,name=uid,proto3" json:"uid,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMicroVMRequest) Descriptor deprecated 

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

Deprecated: Use GetMicroVMRequest.ProtoReflect.Descriptor instead.

func (*GetMicroVMRequest) GetUid 

func (x *GetMicroVMRequest) GetUid() string

func (*GetMicroVMRequest) ProtoMessage 

func (*GetMicroVMRequest) ProtoMessage()

func (*GetMicroVMRequest) ProtoReflect 

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

func (*GetMicroVMRequest) Reset 

func (x *GetMicroVMRequest) Reset()

func (*GetMicroVMRequest) String 

func (x *GetMicroVMRequest) String() string

type GetMicroVMResponse 

type GetMicroVMResponse struct {
	Microvm *types.MicroVM `protobuf:"bytes,1,opt,name=microvm,proto3" json:"microvm,omitempty"`
	// contains filtered or unexported fields
}

func (*GetMicroVMResponse) Descriptor deprecated 

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

Deprecated: Use GetMicroVMResponse.ProtoReflect.Descriptor instead.

func (*GetMicroVMResponse) GetMicrovm 

func (x *GetMicroVMResponse) GetMicrovm() *types.MicroVM

func (*GetMicroVMResponse) ProtoMessage 

func (*GetMicroVMResponse) ProtoMessage()

func (*GetMicroVMResponse) ProtoReflect 

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

func (*GetMicroVMResponse) Reset 

func (x *GetMicroVMResponse) Reset()

func (*GetMicroVMResponse) String 

func (x *GetMicroVMResponse) String() string

type ListMessage 

type ListMessage struct {
	Microvm *types.MicroVM `protobuf:"bytes,1,opt,name=microvm,proto3" json:"microvm,omitempty"`
	// contains filtered or unexported fields
}

func (*ListMessage) Descriptor deprecated 

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

Deprecated: Use ListMessage.ProtoReflect.Descriptor instead.

func (*ListMessage) GetMicrovm 

func (x *ListMessage) GetMicrovm() *types.MicroVM

func (*ListMessage) ProtoMessage 

func (*ListMessage) ProtoMessage()

func (*ListMessage) ProtoReflect 

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

func (*ListMessage) Reset 

func (x *ListMessage) Reset()

func (*ListMessage) String 

func (x *ListMessage) String() string

type ListMicroVMsRequest 

type ListMicroVMsRequest struct {
	Namespace string  `protobuf:"bytes,1,opt,name=namespace,proto3" json:"namespace,omitempty"`
	Name      *string `protobuf:"bytes,2,opt,name=name,proto3,oneof" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*ListMicroVMsRequest) Descriptor deprecated 

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

Deprecated: Use ListMicroVMsRequest.ProtoReflect.Descriptor instead.

func (*ListMicroVMsRequest) GetName 

func (x *ListMicroVMsRequest) GetName() string

func (*ListMicroVMsRequest) GetNamespace 

func (x *ListMicroVMsRequest) GetNamespace() string

func (*ListMicroVMsRequest) ProtoMessage 

func (*ListMicroVMsRequest) ProtoMessage()

func (*ListMicroVMsRequest) ProtoReflect 

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

func (*ListMicroVMsRequest) Reset 

func (x *ListMicroVMsRequest) Reset()

func (*ListMicroVMsRequest) String 

func (x *ListMicroVMsRequest) String() string

type ListMicroVMsResponse 

type ListMicroVMsResponse struct {
	Microvm []*types.MicroVM `protobuf:"bytes,1,rep,name=microvm,proto3" json:"microvm,omitempty"`
	// contains filtered or unexported fields
}

func (*ListMicroVMsResponse) Descriptor deprecated 

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

Deprecated: Use ListMicroVMsResponse.ProtoReflect.Descriptor instead.

func (*ListMicroVMsResponse) GetMicrovm 

func (x *ListMicroVMsResponse) GetMicrovm() []*types.MicroVM

func (*ListMicroVMsResponse) ProtoMessage 

func (*ListMicroVMsResponse) ProtoMessage()

func (*ListMicroVMsResponse) ProtoReflect 

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

func (*ListMicroVMsResponse) Reset 

func (x *ListMicroVMsResponse) Reset()

func (*ListMicroVMsResponse) String 

func (x *ListMicroVMsResponse) String() string

type MicroVMClient 

type MicroVMClient interface {
	CreateMicroVM(ctx context.Context, in *CreateMicroVMRequest, opts ...grpc.CallOption) (*CreateMicroVMResponse, error)
	DeleteMicroVM(ctx context.Context, in *DeleteMicroVMRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	GetMicroVM(ctx context.Context, in *GetMicroVMRequest, opts ...grpc.CallOption) (*GetMicroVMResponse, error)
	ListMicroVMs(ctx context.Context, in *ListMicroVMsRequest, opts ...grpc.CallOption) (*ListMicroVMsResponse, error)
	ListMicroVMsStream(ctx context.Context, in *ListMicroVMsRequest, opts ...grpc.CallOption) (grpc.ServerStreamingClient[ListMessage], error)
}

MicroVMClient is the client API for MicroVM 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.

MicroVM providers a service to create and manage the lifecycle of microvms.

func NewMicroVMClient 

func NewMicroVMClient(cc grpc.ClientConnInterface) MicroVMClient

type MicroVMServer 

type MicroVMServer interface {
	CreateMicroVM(context.Context, *CreateMicroVMRequest) (*CreateMicroVMResponse, error)
	DeleteMicroVM(context.Context, *DeleteMicroVMRequest) (*emptypb.Empty, error)
	GetMicroVM(context.Context, *GetMicroVMRequest) (*GetMicroVMResponse, error)
	ListMicroVMs(context.Context, *ListMicroVMsRequest) (*ListMicroVMsResponse, error)
	ListMicroVMsStream(*ListMicroVMsRequest, grpc.ServerStreamingServer[ListMessage]) error
}

MicroVMServer is the server API for MicroVM service. All implementations should embed UnimplementedMicroVMServer for forward compatibility.

MicroVM providers a service to create and manage the lifecycle of microvms.

type MicroVM_ListMicroVMsStreamClient 

type MicroVM_ListMicroVMsStreamClient = grpc.ServerStreamingClient[ListMessage]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type MicroVM_ListMicroVMsStreamServer 

type MicroVM_ListMicroVMsStreamServer = grpc.ServerStreamingServer[ListMessage]

This type alias is provided for backwards compatibility with existing code that references the prior non-generic stream type by name.

type UnimplementedMicroVMServer 

type UnimplementedMicroVMServer struct{}

UnimplementedMicroVMServer should be embedded to have forward compatible implementations.

NOTE: this should be embedded by value instead of pointer to avoid a nil pointer dereference when methods are called.

func (UnimplementedMicroVMServer) CreateMicroVM 

func (UnimplementedMicroVMServer) CreateMicroVM(context.Context, *CreateMicroVMRequest) (*CreateMicroVMResponse, error)

func (UnimplementedMicroVMServer) DeleteMicroVM 

func (UnimplementedMicroVMServer) DeleteMicroVM(context.Context, *DeleteMicroVMRequest) (*emptypb.Empty, error)

func (UnimplementedMicroVMServer) GetMicroVM 

func (UnimplementedMicroVMServer) GetMicroVM(context.Context, *GetMicroVMRequest) (*GetMicroVMResponse, error)

func (UnimplementedMicroVMServer) ListMicroVMs 

func (UnimplementedMicroVMServer) ListMicroVMs(context.Context, *ListMicroVMsRequest) (*ListMicroVMsResponse, error)

func (UnimplementedMicroVMServer) ListMicroVMsStream 

func (UnimplementedMicroVMServer) ListMicroVMsStream(*ListMicroVMsRequest, grpc.ServerStreamingServer[ListMessage]) error

type UnsafeMicroVMServer 

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

UnsafeMicroVMServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to MicroVMServer 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.