blueprints

package
v0.0.21 Latest Latest
Warning

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

 Go to latest Published: Jan 6, 2026 License: Apache-2.0 Imports: 22 Imported by: 0

Documentation

Overview

Package blueprints is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	Blueprints_ListBlueprints_FullMethodName    = "/Superplane.Blueprints.Blueprints/ListBlueprints"
	Blueprints_DescribeBlueprint_FullMethodName = "/Superplane.Blueprints.Blueprints/DescribeBlueprint"
	Blueprints_CreateBlueprint_FullMethodName   = "/Superplane.Blueprints.Blueprints/CreateBlueprint"
	Blueprints_UpdateBlueprint_FullMethodName   = "/Superplane.Blueprints.Blueprints/UpdateBlueprint"
	Blueprints_DeleteBlueprint_FullMethodName   = "/Superplane.Blueprints.Blueprints/DeleteBlueprint"
)

Variables

View Source 
var Blueprints_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "Superplane.Blueprints.Blueprints",
	HandlerType: (*BlueprintsServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListBlueprints",
			Handler:    _Blueprints_ListBlueprints_Handler,
		},
		{
			MethodName: "DescribeBlueprint",
			Handler:    _Blueprints_DescribeBlueprint_Handler,
		},
		{
			MethodName: "CreateBlueprint",
			Handler:    _Blueprints_CreateBlueprint_Handler,
		},
		{
			MethodName: "UpdateBlueprint",
			Handler:    _Blueprints_UpdateBlueprint_Handler,
		},
		{
			MethodName: "DeleteBlueprint",
			Handler:    _Blueprints_DeleteBlueprint_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "blueprints.proto",
}

Blueprints_ServiceDesc is the grpc.ServiceDesc for Blueprints 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_blueprints_proto protoreflect.FileDescriptor

Functions

func RegisterBlueprintsHandler 

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

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

func RegisterBlueprintsHandlerClient 

func RegisterBlueprintsHandlerClient(ctx context.Context, mux *runtime.ServeMux, client BlueprintsClient) error

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

func RegisterBlueprintsHandlerFromEndpoint 

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

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

func RegisterBlueprintsHandlerServer 

func RegisterBlueprintsHandlerServer(ctx context.Context, mux *runtime.ServeMux, server BlueprintsServer) error

RegisterBlueprintsHandlerServer registers the http handlers for service Blueprints to "mux". UnaryRPC :call BlueprintsServer 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 RegisterBlueprintsHandlerFromEndpoint 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 RegisterBlueprintsServer 

func RegisterBlueprintsServer(s grpc.ServiceRegistrar, srv BlueprintsServer)

Types

type Blueprint 

type Blueprint struct {
	Id             string                 `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	OrganizationId string                 `protobuf:"bytes,2,opt,name=organization_id,json=organizationId,proto3" json:"organization_id,omitempty"`
	Name           string                 `protobuf:"bytes,3,opt,name=name,proto3" json:"name,omitempty"`
	Description    string                 `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
	CreatedAt      *timestamp.Timestamp   `protobuf:"bytes,5,opt,name=created_at,json=createdAt,proto3" json:"created_at,omitempty"`
	UpdatedAt      *timestamp.Timestamp   `protobuf:"bytes,6,opt,name=updated_at,json=updatedAt,proto3" json:"updated_at,omitempty"`
	Nodes          []*components.Node     `protobuf:"bytes,7,rep,name=nodes,proto3" json:"nodes,omitempty"`
	Edges          []*components.Edge     `protobuf:"bytes,8,rep,name=edges,proto3" json:"edges,omitempty"`
	Configuration  []*configuration.Field `protobuf:"bytes,9,rep,name=configuration,proto3" json:"configuration,omitempty"`
	OutputChannels []*OutputChannel       `protobuf:"bytes,10,rep,name=output_channels,json=outputChannels,proto3" json:"output_channels,omitempty"`
	Icon           string                 `protobuf:"bytes,11,opt,name=icon,proto3" json:"icon,omitempty"`
	Color          string                 `protobuf:"bytes,12,opt,name=color,proto3" json:"color,omitempty"`
	CreatedBy      *UserRef               `protobuf:"bytes,13,opt,name=created_by,json=createdBy,proto3" json:"created_by,omitempty"`
	// contains filtered or unexported fields
}

func (*Blueprint) Descriptor deprecated 

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

Deprecated: Use Blueprint.ProtoReflect.Descriptor instead.

func (*Blueprint) GetColor 

func (x *Blueprint) GetColor() string

func (*Blueprint) GetConfiguration 

func (x *Blueprint) GetConfiguration() []*configuration.Field

func (*Blueprint) GetCreatedAt 

func (x *Blueprint) GetCreatedAt() *timestamp.Timestamp

func (*Blueprint) GetCreatedBy 

func (x *Blueprint) GetCreatedBy() *UserRef

func (*Blueprint) GetDescription 

func (x *Blueprint) GetDescription() string

func (*Blueprint) GetEdges 

func (x *Blueprint) GetEdges() []*components.Edge

func (*Blueprint) GetIcon 

func (x *Blueprint) GetIcon() string

func (*Blueprint) GetId 

func (x *Blueprint) GetId() string

func (*Blueprint) GetName 

func (x *Blueprint) GetName() string

func (*Blueprint) GetNodes 

func (x *Blueprint) GetNodes() []*components.Node

func (*Blueprint) GetOrganizationId 

func (x *Blueprint) GetOrganizationId() string

func (*Blueprint) GetOutputChannels 

func (x *Blueprint) GetOutputChannels() []*OutputChannel

func (*Blueprint) GetUpdatedAt 

func (x *Blueprint) GetUpdatedAt() *timestamp.Timestamp

func (*Blueprint) ProtoMessage 

func (*Blueprint) ProtoMessage()

func (*Blueprint) ProtoReflect 

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

func (*Blueprint) Reset 

func (x *Blueprint) Reset()

func (*Blueprint) String 

func (x *Blueprint) String() string

type BlueprintsClient 

type BlueprintsClient interface {
	ListBlueprints(ctx context.Context, in *ListBlueprintsRequest, opts ...grpc.CallOption) (*ListBlueprintsResponse, error)
	DescribeBlueprint(ctx context.Context, in *DescribeBlueprintRequest, opts ...grpc.CallOption) (*DescribeBlueprintResponse, error)
	CreateBlueprint(ctx context.Context, in *CreateBlueprintRequest, opts ...grpc.CallOption) (*CreateBlueprintResponse, error)
	UpdateBlueprint(ctx context.Context, in *UpdateBlueprintRequest, opts ...grpc.CallOption) (*UpdateBlueprintResponse, error)
	DeleteBlueprint(ctx context.Context, in *DeleteBlueprintRequest, opts ...grpc.CallOption) (*DeleteBlueprintResponse, error)
}

BlueprintsClient is the client API for Blueprints 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 NewBlueprintsClient 

func NewBlueprintsClient(cc grpc.ClientConnInterface) BlueprintsClient

type BlueprintsServer 

type BlueprintsServer interface {
	ListBlueprints(context.Context, *ListBlueprintsRequest) (*ListBlueprintsResponse, error)
	DescribeBlueprint(context.Context, *DescribeBlueprintRequest) (*DescribeBlueprintResponse, error)
	CreateBlueprint(context.Context, *CreateBlueprintRequest) (*CreateBlueprintResponse, error)
	UpdateBlueprint(context.Context, *UpdateBlueprintRequest) (*UpdateBlueprintResponse, error)
	DeleteBlueprint(context.Context, *DeleteBlueprintRequest) (*DeleteBlueprintResponse, error)
}

BlueprintsServer is the server API for Blueprints service. All implementations should embed UnimplementedBlueprintsServer for forward compatibility.

type CreateBlueprintRequest 

type CreateBlueprintRequest struct {
	Blueprint *Blueprint `protobuf:"bytes,1,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateBlueprintRequest) Descriptor deprecated 

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

Deprecated: Use CreateBlueprintRequest.ProtoReflect.Descriptor instead.

func (*CreateBlueprintRequest) GetBlueprint 

func (x *CreateBlueprintRequest) GetBlueprint() *Blueprint

func (*CreateBlueprintRequest) ProtoMessage 

func (*CreateBlueprintRequest) ProtoMessage()

func (*CreateBlueprintRequest) ProtoReflect 

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

func (*CreateBlueprintRequest) Reset 

func (x *CreateBlueprintRequest) Reset()

func (*CreateBlueprintRequest) String 

func (x *CreateBlueprintRequest) String() string

type CreateBlueprintResponse 

type CreateBlueprintResponse struct {
	Blueprint *Blueprint `protobuf:"bytes,1,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

func (*CreateBlueprintResponse) Descriptor deprecated 

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

Deprecated: Use CreateBlueprintResponse.ProtoReflect.Descriptor instead.

func (*CreateBlueprintResponse) GetBlueprint 

func (x *CreateBlueprintResponse) GetBlueprint() *Blueprint

func (*CreateBlueprintResponse) ProtoMessage 

func (*CreateBlueprintResponse) ProtoMessage()

func (*CreateBlueprintResponse) ProtoReflect 

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

func (*CreateBlueprintResponse) Reset 

func (x *CreateBlueprintResponse) Reset()

func (*CreateBlueprintResponse) String 

func (x *CreateBlueprintResponse) String() string

type DeleteBlueprintRequest 

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

func (*DeleteBlueprintRequest) Descriptor deprecated 

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

Deprecated: Use DeleteBlueprintRequest.ProtoReflect.Descriptor instead.

func (*DeleteBlueprintRequest) GetId 

func (x *DeleteBlueprintRequest) GetId() string

func (*DeleteBlueprintRequest) ProtoMessage 

func (*DeleteBlueprintRequest) ProtoMessage()

func (*DeleteBlueprintRequest) ProtoReflect 

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

func (*DeleteBlueprintRequest) Reset 

func (x *DeleteBlueprintRequest) Reset()

func (*DeleteBlueprintRequest) String 

func (x *DeleteBlueprintRequest) String() string

type DeleteBlueprintResponse 

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

func (*DeleteBlueprintResponse) Descriptor deprecated 

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

Deprecated: Use DeleteBlueprintResponse.ProtoReflect.Descriptor instead.

func (*DeleteBlueprintResponse) ProtoMessage 

func (*DeleteBlueprintResponse) ProtoMessage()

func (*DeleteBlueprintResponse) ProtoReflect 

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

func (*DeleteBlueprintResponse) Reset 

func (x *DeleteBlueprintResponse) Reset()

func (*DeleteBlueprintResponse) String 

func (x *DeleteBlueprintResponse) String() string

type DescribeBlueprintRequest 

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

func (*DescribeBlueprintRequest) Descriptor deprecated 

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

Deprecated: Use DescribeBlueprintRequest.ProtoReflect.Descriptor instead.

func (*DescribeBlueprintRequest) GetId 

func (x *DescribeBlueprintRequest) GetId() string

func (*DescribeBlueprintRequest) ProtoMessage 

func (*DescribeBlueprintRequest) ProtoMessage()

func (*DescribeBlueprintRequest) ProtoReflect 

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

func (*DescribeBlueprintRequest) Reset 

func (x *DescribeBlueprintRequest) Reset()

func (*DescribeBlueprintRequest) String 

func (x *DescribeBlueprintRequest) String() string

type DescribeBlueprintResponse 

type DescribeBlueprintResponse struct {
	Blueprint *Blueprint `protobuf:"bytes,1,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

func (*DescribeBlueprintResponse) Descriptor deprecated 

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

Deprecated: Use DescribeBlueprintResponse.ProtoReflect.Descriptor instead.

func (*DescribeBlueprintResponse) GetBlueprint 

func (x *DescribeBlueprintResponse) GetBlueprint() *Blueprint

func (*DescribeBlueprintResponse) ProtoMessage 

func (*DescribeBlueprintResponse) ProtoMessage()

func (*DescribeBlueprintResponse) ProtoReflect 

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

func (*DescribeBlueprintResponse) Reset 

func (x *DescribeBlueprintResponse) Reset()

func (*DescribeBlueprintResponse) String 

func (x *DescribeBlueprintResponse) String() string

type ListBlueprintsRequest 

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

func (*ListBlueprintsRequest) Descriptor deprecated 

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

Deprecated: Use ListBlueprintsRequest.ProtoReflect.Descriptor instead.

func (*ListBlueprintsRequest) ProtoMessage 

func (*ListBlueprintsRequest) ProtoMessage()

func (*ListBlueprintsRequest) ProtoReflect 

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

func (*ListBlueprintsRequest) Reset 

func (x *ListBlueprintsRequest) Reset()

func (*ListBlueprintsRequest) String 

func (x *ListBlueprintsRequest) String() string

type ListBlueprintsResponse 

type ListBlueprintsResponse struct {
	Blueprints []*Blueprint `protobuf:"bytes,1,rep,name=blueprints,proto3" json:"blueprints,omitempty"`
	// contains filtered or unexported fields
}

func (*ListBlueprintsResponse) Descriptor deprecated 

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

Deprecated: Use ListBlueprintsResponse.ProtoReflect.Descriptor instead.

func (*ListBlueprintsResponse) GetBlueprints 

func (x *ListBlueprintsResponse) GetBlueprints() []*Blueprint

func (*ListBlueprintsResponse) ProtoMessage 

func (*ListBlueprintsResponse) ProtoMessage()

func (*ListBlueprintsResponse) ProtoReflect 

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

func (*ListBlueprintsResponse) Reset 

func (x *ListBlueprintsResponse) Reset()

func (*ListBlueprintsResponse) String 

func (x *ListBlueprintsResponse) String() string

type OutputChannel 

type OutputChannel struct {
	Name              string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	NodeId            string `protobuf:"bytes,2,opt,name=node_id,json=nodeId,proto3" json:"node_id,omitempty"`
	NodeOutputChannel string `protobuf:"bytes,3,opt,name=node_output_channel,json=nodeOutputChannel,proto3" json:"node_output_channel,omitempty"`
	// contains filtered or unexported fields
}

func (*OutputChannel) Descriptor deprecated 

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

Deprecated: Use OutputChannel.ProtoReflect.Descriptor instead.

func (*OutputChannel) GetName 

func (x *OutputChannel) GetName() string

func (*OutputChannel) GetNodeId 

func (x *OutputChannel) GetNodeId() string

func (*OutputChannel) GetNodeOutputChannel 

func (x *OutputChannel) GetNodeOutputChannel() string

func (*OutputChannel) ProtoMessage 

func (*OutputChannel) ProtoMessage()

func (*OutputChannel) ProtoReflect 

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

func (*OutputChannel) Reset 

func (x *OutputChannel) Reset()

func (*OutputChannel) String 

func (x *OutputChannel) String() string

type UnimplementedBlueprintsServer 

type UnimplementedBlueprintsServer struct{}

UnimplementedBlueprintsServer 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 (UnimplementedBlueprintsServer) CreateBlueprint 

func (UnimplementedBlueprintsServer) CreateBlueprint(context.Context, *CreateBlueprintRequest) (*CreateBlueprintResponse, error)

func (UnimplementedBlueprintsServer) DeleteBlueprint 

func (UnimplementedBlueprintsServer) DeleteBlueprint(context.Context, *DeleteBlueprintRequest) (*DeleteBlueprintResponse, error)

func (UnimplementedBlueprintsServer) DescribeBlueprint 

func (UnimplementedBlueprintsServer) DescribeBlueprint(context.Context, *DescribeBlueprintRequest) (*DescribeBlueprintResponse, error)

func (UnimplementedBlueprintsServer) ListBlueprints 

func (UnimplementedBlueprintsServer) ListBlueprints(context.Context, *ListBlueprintsRequest) (*ListBlueprintsResponse, error)

func (UnimplementedBlueprintsServer) UpdateBlueprint 

func (UnimplementedBlueprintsServer) UpdateBlueprint(context.Context, *UpdateBlueprintRequest) (*UpdateBlueprintResponse, error)

type UnsafeBlueprintsServer 

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

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

type UpdateBlueprintRequest 

type UpdateBlueprintRequest struct {
	Id        string     `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Blueprint *Blueprint `protobuf:"bytes,2,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateBlueprintRequest) Descriptor deprecated 

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

Deprecated: Use UpdateBlueprintRequest.ProtoReflect.Descriptor instead.

func (*UpdateBlueprintRequest) GetBlueprint 

func (x *UpdateBlueprintRequest) GetBlueprint() *Blueprint

func (*UpdateBlueprintRequest) GetId 

func (x *UpdateBlueprintRequest) GetId() string

func (*UpdateBlueprintRequest) ProtoMessage 

func (*UpdateBlueprintRequest) ProtoMessage()

func (*UpdateBlueprintRequest) ProtoReflect 

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

func (*UpdateBlueprintRequest) Reset 

func (x *UpdateBlueprintRequest) Reset()

func (*UpdateBlueprintRequest) String 

func (x *UpdateBlueprintRequest) String() string

type UpdateBlueprintResponse 

type UpdateBlueprintResponse struct {
	Blueprint *Blueprint `protobuf:"bytes,1,opt,name=blueprint,proto3" json:"blueprint,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateBlueprintResponse) Descriptor deprecated 

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

Deprecated: Use UpdateBlueprintResponse.ProtoReflect.Descriptor instead.

func (*UpdateBlueprintResponse) GetBlueprint 

func (x *UpdateBlueprintResponse) GetBlueprint() *Blueprint

func (*UpdateBlueprintResponse) ProtoMessage 

func (*UpdateBlueprintResponse) ProtoMessage()

func (*UpdateBlueprintResponse) ProtoReflect 

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

func (*UpdateBlueprintResponse) Reset 

func (x *UpdateBlueprintResponse) Reset()

func (*UpdateBlueprintResponse) String 

func (x *UpdateBlueprintResponse) String() string

type UserRef 

type UserRef struct {
	Id   string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

func (*UserRef) Descriptor deprecated 

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

Deprecated: Use UserRef.ProtoReflect.Descriptor instead.

func (*UserRef) GetId 

func (x *UserRef) GetId() string

func (*UserRef) GetName 

func (x *UserRef) GetName() string

func (*UserRef) ProtoMessage 

func (*UserRef) ProtoMessage()

func (*UserRef) ProtoReflect 

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

func (*UserRef) Reset 

func (x *UserRef) Reset()

func (*UserRef) String 

func (x *UserRef) 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.