definition

package
v0.0.0-...-abcbab4 Latest Latest
Warning

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

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

Documentation

Overview

Package definition is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

View Source 
const (
	InventoryV1_Inventory_FullMethodName = "/inventory.InventoryV1/Inventory"
)

Variables

View Source 
var (
	ArangoDBMode_name = map[int32]string{
		0: "Single",
		1: "ActiveFailover",
		2: "Cluster",
	}
	ArangoDBMode_value = map[string]int32{
		"Single":         0,
		"ActiveFailover": 1,
		"Cluster":        2,
	}
)

Enum value maps for ArangoDBMode.

View Source 
var (
	ArangoDBEdition_name = map[int32]string{
		0: "Community",
		1: "Enterprise",
	}
	ArangoDBEdition_value = map[string]int32{
		"Community":  0,
		"Enterprise": 1,
	}
)

Enum value maps for ArangoDBEdition.

View Source 
var (
	ArangoDBSharding_name = map[int32]string{
		0: "Sharded",
		1: "OneShardEnforced",
	}
	ArangoDBSharding_value = map[string]int32{
		"Sharded":          0,
		"OneShardEnforced": 1,
	}
)

Enum value maps for ArangoDBSharding.

View Source 
var File_integrations_inventory_v1_definition_inventory_proto protoreflect.FileDescriptor
View Source 
var File_integrations_inventory_v1_definition_service_proto protoreflect.FileDescriptor
View Source 
var InventoryV1_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "inventory.InventoryV1",
	HandlerType: (*InventoryV1Server)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "Inventory",
			Handler:    _InventoryV1_Inventory_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "integrations/inventory/v1/definition/service.proto",
}

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

Functions

func RegisterInventoryV1Handler 

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

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

func RegisterInventoryV1HandlerClient 

func RegisterInventoryV1HandlerClient(ctx context.Context, mux *runtime.ServeMux, client InventoryV1Client) error

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

func RegisterInventoryV1HandlerFromEndpoint 

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

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

func RegisterInventoryV1HandlerServer 

func RegisterInventoryV1HandlerServer(ctx context.Context, mux *runtime.ServeMux, server InventoryV1Server) error

RegisterInventoryV1HandlerServer registers the http handlers for service InventoryV1 to "mux". UnaryRPC :call InventoryV1Server 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 RegisterInventoryV1HandlerFromEndpoint 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 RegisterInventoryV1Server 

func RegisterInventoryV1Server(s grpc.ServiceRegistrar, srv InventoryV1Server)

Types

type ArangoDBConfiguration 

type ArangoDBConfiguration struct {

	// ArangoDB Deployment Mode
	Mode ArangoDBMode `protobuf:"varint,1,opt,name=mode,proto3,enum=inventory.ArangoDBMode" json:"mode,omitempty"`
	// ArangoDB Deployment Edition
	Edition ArangoDBEdition `protobuf:"varint,2,opt,name=edition,proto3,enum=inventory.ArangoDBEdition" json:"edition,omitempty"`
	// ArangoDB Deployment Version
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// ArangoDB Sharding Mode
	Sharding ArangoDBSharding `protobuf:"varint,4,opt,name=sharding,proto3,enum=inventory.ArangoDBSharding" json:"sharding,omitempty"`
	// contains filtered or unexported fields
}

ArangoDB Deployment Configuration

func NewArangoDBConfiguration 

func NewArangoDBConfiguration(spec api.DeploymentSpec, status api.DeploymentStatus) *ArangoDBConfiguration

func (*ArangoDBConfiguration) Descriptor deprecated 

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

Deprecated: Use ArangoDBConfiguration.ProtoReflect.Descriptor instead.

func (*ArangoDBConfiguration) GetEdition 

func (x *ArangoDBConfiguration) GetEdition() ArangoDBEdition

func (*ArangoDBConfiguration) GetMode 

func (x *ArangoDBConfiguration) GetMode() ArangoDBMode

func (*ArangoDBConfiguration) GetSharding 

func (x *ArangoDBConfiguration) GetSharding() ArangoDBSharding

func (*ArangoDBConfiguration) GetVersion 

func (x *ArangoDBConfiguration) GetVersion() string

func (*ArangoDBConfiguration) ProtoMessage 

func (*ArangoDBConfiguration) ProtoMessage()

func (*ArangoDBConfiguration) ProtoReflect 

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

func (*ArangoDBConfiguration) Reset 

func (x *ArangoDBConfiguration) Reset()

func (*ArangoDBConfiguration) String 

func (x *ArangoDBConfiguration) String() string

type ArangoDBEdition 

type ArangoDBEdition int32

ArangoDB Deployment Edition 

const (
	// Community Edition
	ArangoDBEdition_Community ArangoDBEdition = 0
	// Enterprise Edition
	ArangoDBEdition_Enterprise ArangoDBEdition = 1
)

func (ArangoDBEdition) Descriptor 

func (ArangoDBEdition) Descriptor() protoreflect.EnumDescriptor

func (ArangoDBEdition) Enum 

func (x ArangoDBEdition) Enum() *ArangoDBEdition

func (ArangoDBEdition) EnumDescriptor deprecated 

func (ArangoDBEdition) EnumDescriptor() ([]byte, []int)

Deprecated: Use ArangoDBEdition.Descriptor instead.

func (ArangoDBEdition) Number 

func (x ArangoDBEdition) Number() protoreflect.EnumNumber

func (ArangoDBEdition) String 

func (x ArangoDBEdition) String() string

func (ArangoDBEdition) Type 

func (ArangoDBEdition) Type() protoreflect.EnumType

type ArangoDBMode 

type ArangoDBMode int32

ArangoDB Deployment Mode 

const (
	// Single Mode
	ArangoDBMode_Single ArangoDBMode = 0
	// ActiveFailover Mode
	ArangoDBMode_ActiveFailover ArangoDBMode = 1
	// Cluster Mode
	ArangoDBMode_Cluster ArangoDBMode = 2
)

func (ArangoDBMode) Descriptor 

func (ArangoDBMode) Descriptor() protoreflect.EnumDescriptor

func (ArangoDBMode) Enum 

func (x ArangoDBMode) Enum() *ArangoDBMode

func (ArangoDBMode) EnumDescriptor deprecated 

func (ArangoDBMode) EnumDescriptor() ([]byte, []int)

Deprecated: Use ArangoDBMode.Descriptor instead.

func (ArangoDBMode) Number 

func (x ArangoDBMode) Number() protoreflect.EnumNumber

func (ArangoDBMode) String 

func (x ArangoDBMode) String() string

func (ArangoDBMode) Type 

func (ArangoDBMode) Type() protoreflect.EnumType

type ArangoDBSharding 

type ArangoDBSharding int32

ArangoDB Sharding Mode 

const (
	// Sharded Sharding Mode
	ArangoDBSharding_Sharded ArangoDBSharding = 0
	// OneShardEnforced Sharding Mode
	ArangoDBSharding_OneShardEnforced ArangoDBSharding = 1
)

func (ArangoDBSharding) Descriptor 

func (ArangoDBSharding) Descriptor() protoreflect.EnumDescriptor

func (ArangoDBSharding) Enum 

func (x ArangoDBSharding) Enum() *ArangoDBSharding

func (ArangoDBSharding) EnumDescriptor deprecated 

func (ArangoDBSharding) EnumDescriptor() ([]byte, []int)

Deprecated: Use ArangoDBSharding.Descriptor instead.

func (ArangoDBSharding) Number 

func (x ArangoDBSharding) Number() protoreflect.EnumNumber

func (ArangoDBSharding) String 

func (x ArangoDBSharding) String() string

func (ArangoDBSharding) Type 

func (ArangoDBSharding) Type() protoreflect.EnumType

type Inventory 

type Inventory struct {

	// Current Envoy Configuration details
	Configuration *InventoryConfiguration `protobuf:"bytes,1,opt,name=configuration,proto3,oneof" json:"configuration,omitempty"`
	// ArangoDB Deployment Configuration
	Arangodb *ArangoDBConfiguration `protobuf:"bytes,2,opt,name=arangodb,proto3,oneof" json:"arangodb,omitempty"`
	// ArangoDB Platform Networking
	Networking *InventoryNetworking `protobuf:"bytes,3,opt,name=networking,proto3,oneof" json:"networking,omitempty"`
	// ArangoDB Platform Spec
	Platform *InventoryPlatform `protobuf:"bytes,4,opt,name=platform,proto3,oneof" json:"platform,omitempty"`
	// contains filtered or unexported fields
}

Platform Inventory

func (*Inventory) Descriptor deprecated 

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

Deprecated: Use Inventory.ProtoReflect.Descriptor instead.

func (*Inventory) GetArangodb 

func (x *Inventory) GetArangodb() *ArangoDBConfiguration

func (*Inventory) GetConfiguration 

func (x *Inventory) GetConfiguration() *InventoryConfiguration

func (*Inventory) GetNetworking 

func (x *Inventory) GetNetworking() *InventoryNetworking

func (*Inventory) GetPlatform 

func (x *Inventory) GetPlatform() *InventoryPlatform

func (*Inventory) JSON 

func (s *Inventory) JSON() ([]byte, error)

func (*Inventory) ProtoMessage 

func (*Inventory) ProtoMessage()

func (*Inventory) ProtoReflect 

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

func (*Inventory) Reset 

func (x *Inventory) Reset()

func (*Inventory) String 

func (x *Inventory) String() string

type InventoryConfiguration 

type InventoryConfiguration struct {

	// Configuration hash
	Hash string `protobuf:"bytes,1,opt,name=hash,proto3" json:"hash,omitempty"`
	// contains filtered or unexported fields
}

Envoy Configuration details

func (*InventoryConfiguration) Descriptor deprecated 

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

Deprecated: Use InventoryConfiguration.ProtoReflect.Descriptor instead.

func (*InventoryConfiguration) GetHash 

func (x *InventoryConfiguration) GetHash() string

func (*InventoryConfiguration) ProtoMessage 

func (*InventoryConfiguration) ProtoMessage()

func (*InventoryConfiguration) ProtoReflect 

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

func (*InventoryConfiguration) Reset 

func (x *InventoryConfiguration) Reset()

func (*InventoryConfiguration) String 

func (x *InventoryConfiguration) String() string

type InventoryNetworking 

type InventoryNetworking struct {

	// Defines Routes definition
	Routes map[string]*InventoryNetworkingRoute `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

Envoy Configuration details

func (*InventoryNetworking) Descriptor deprecated 

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

Deprecated: Use InventoryNetworking.ProtoReflect.Descriptor instead.

func (*InventoryNetworking) GetRoutes 

func (x *InventoryNetworking) GetRoutes() map[string]*InventoryNetworkingRoute

func (*InventoryNetworking) ProtoMessage 

func (*InventoryNetworking) ProtoMessage()

func (*InventoryNetworking) ProtoReflect 

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

func (*InventoryNetworking) Reset 

func (x *InventoryNetworking) Reset()

func (*InventoryNetworking) String 

func (x *InventoryNetworking) String() string

type InventoryNetworkingRoute 

type InventoryNetworkingRoute struct {

	// Types that are assignable to Route:
	//
	//	*InventoryNetworkingRoute_Path
	Route isInventoryNetworkingRoute_Route `protobuf_oneof:"route"`
	// contains filtered or unexported fields
}

Envoy Route Configuration details

func (*InventoryNetworkingRoute) Descriptor deprecated 

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

Deprecated: Use InventoryNetworkingRoute.ProtoReflect.Descriptor instead.

func (*InventoryNetworkingRoute) GetPath 

func (x *InventoryNetworkingRoute) GetPath() *InventoryNetworkingRoutePath

func (*InventoryNetworkingRoute) GetRoute 

func (m *InventoryNetworkingRoute) GetRoute() isInventoryNetworkingRoute_Route

func (*InventoryNetworkingRoute) ProtoMessage 

func (*InventoryNetworkingRoute) ProtoMessage()

func (*InventoryNetworkingRoute) ProtoReflect 

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

func (*InventoryNetworkingRoute) Reset 

func (x *InventoryNetworkingRoute) Reset()

func (*InventoryNetworkingRoute) String 

func (x *InventoryNetworkingRoute) String() string

type InventoryNetworkingRoutePath 

type InventoryNetworkingRoutePath struct {

	// Path definition
	Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
	// contains filtered or unexported fields
}

Envoy Route Path Configuration details

func (*InventoryNetworkingRoutePath) Descriptor deprecated 

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

Deprecated: Use InventoryNetworkingRoutePath.ProtoReflect.Descriptor instead.

func (*InventoryNetworkingRoutePath) GetPath 

func (x *InventoryNetworkingRoutePath) GetPath() string

func (*InventoryNetworkingRoutePath) ProtoMessage 

func (*InventoryNetworkingRoutePath) ProtoMessage()

func (*InventoryNetworkingRoutePath) ProtoReflect 

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

func (*InventoryNetworkingRoutePath) Reset 

func (x *InventoryNetworkingRoutePath) Reset()

func (*InventoryNetworkingRoutePath) String 

func (x *InventoryNetworkingRoutePath) String() string

type InventoryNetworkingRoute_Path 

type InventoryNetworkingRoute_Path struct {
	// Path Route
	Path *InventoryNetworkingRoutePath `protobuf:"bytes,1,opt,name=path,proto3,oneof"`
}

type InventoryPlatform 

type InventoryPlatform struct {

	// Defines Services definition
	Services map[string]*InventoryPlatformService `` /* 157-byte string literal not displayed */
	// contains filtered or unexported fields
}

Platform Configuration details

func (*InventoryPlatform) Descriptor deprecated 

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

Deprecated: Use InventoryPlatform.ProtoReflect.Descriptor instead.

func (*InventoryPlatform) GetServices 

func (x *InventoryPlatform) GetServices() map[string]*InventoryPlatformService

func (*InventoryPlatform) ProtoMessage 

func (*InventoryPlatform) ProtoMessage()

func (*InventoryPlatform) ProtoReflect 

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

func (*InventoryPlatform) Reset 

func (x *InventoryPlatform) Reset()

func (*InventoryPlatform) String 

func (x *InventoryPlatform) String() string

type InventoryPlatformService 

type InventoryPlatformService struct {

	// Service Version
	Version string `protobuf:"bytes,1,opt,name=version,proto3" json:"version,omitempty"`
	// Defines if Service is Ready
	Ready bool `protobuf:"varint,2,opt,name=ready,proto3" json:"ready,omitempty"`
	// contains filtered or unexported fields
}

Envoy Service Configuration details

func (*InventoryPlatformService) Descriptor deprecated 

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

Deprecated: Use InventoryPlatformService.ProtoReflect.Descriptor instead.

func (*InventoryPlatformService) GetReady 

func (x *InventoryPlatformService) GetReady() bool

func (*InventoryPlatformService) GetVersion 

func (x *InventoryPlatformService) GetVersion() string

func (*InventoryPlatformService) ProtoMessage 

func (*InventoryPlatformService) ProtoMessage()

func (*InventoryPlatformService) ProtoReflect 

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

func (*InventoryPlatformService) Reset 

func (x *InventoryPlatformService) Reset()

func (*InventoryPlatformService) String 

func (x *InventoryPlatformService) String() string

type InventoryV1Client 

type InventoryV1Client interface {
	// Inventory returns current State
	Inventory(ctx context.Context, in *definition.Empty, opts ...grpc.CallOption) (*Inventory, error)
}

InventoryV1Client is the client API for InventoryV1 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.

InventoryV1 Service Definition for Client

func NewInventoryV1Client 

func NewInventoryV1Client(cc grpc.ClientConnInterface) InventoryV1Client

type InventoryV1Server 

type InventoryV1Server interface {
	// Inventory returns current State
	Inventory(context.Context, *definition.Empty) (*Inventory, error)
	// contains filtered or unexported methods
}

InventoryV1Server is the server API for InventoryV1 service. All implementations must embed UnimplementedInventoryV1Server for forward compatibility.

InventoryV1 Service Definition for Client

type UnimplementedInventoryV1Server 

type UnimplementedInventoryV1Server struct{}

UnimplementedInventoryV1Server must 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 (UnimplementedInventoryV1Server) Inventory 

func (UnimplementedInventoryV1Server) Inventory(context.Context, *definition.Empty) (*Inventory, error)

type UnsafeInventoryV1Server 

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

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