settingspb

package
v0.5.1 Latest Latest
Warning

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

Go to latest
Published: Mar 28, 2026 License: AGPL-3.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

View Source
const (
	SettingsPlugin_ListSettings_FullMethodName    = "/omniview.sdk.settings.v1.SettingsPlugin/ListSettings"
	SettingsPlugin_GetSetting_FullMethodName      = "/omniview.sdk.settings.v1.SettingsPlugin/GetSetting"
	SettingsPlugin_GetSettingValue_FullMethodName = "/omniview.sdk.settings.v1.SettingsPlugin/GetSettingValue"
	SettingsPlugin_SetSetting_FullMethodName      = "/omniview.sdk.settings.v1.SettingsPlugin/SetSetting"
	SettingsPlugin_SetSettings_FullMethodName     = "/omniview.sdk.settings.v1.SettingsPlugin/SetSettings"
)

Variables

View Source
var (
	SettingType_name = map[int32]string{
		0: "SETTING_TYPE_TEXT",
		1: "SETTING_TYPE_SELECT",
		2: "SETTING_TYPE_MULTI_SELECT",
		3: "SETTING_TYPE_INTEGER",
		4: "SETTING_TYPE_FLOAT",
		5: "SETTING_TYPE_TOGGLE",
		6: "SETTING_TYPE_COLOR",
		7: "SETTING_TYPE_DATETIME",
		8: "SETTING_TYPE_PASSWORD",
	}
	SettingType_value = map[string]int32{
		"SETTING_TYPE_TEXT":         0,
		"SETTING_TYPE_SELECT":       1,
		"SETTING_TYPE_MULTI_SELECT": 2,
		"SETTING_TYPE_INTEGER":      3,
		"SETTING_TYPE_FLOAT":        4,
		"SETTING_TYPE_TOGGLE":       5,
		"SETTING_TYPE_COLOR":        6,
		"SETTING_TYPE_DATETIME":     7,
		"SETTING_TYPE_PASSWORD":     8,
	}
)

Enum value maps for SettingType.

View Source
var (
	VisualResourceComponent_ComponentType_name = map[int32]string{
		0: "SIDEBAR",
		1: "TABLE",
		2: "TABLE_ROW",
		3: "TABLE_CELL",
	}
	VisualResourceComponent_ComponentType_value = map[string]int32{
		"SIDEBAR":    0,
		"TABLE":      1,
		"TABLE_ROW":  2,
		"TABLE_CELL": 3,
	}
)

Enum value maps for VisualResourceComponent_ComponentType.

View Source
var File_proto_v1_settings_settings_proto protoreflect.FileDescriptor
View Source
var SettingsPlugin_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "omniview.sdk.settings.v1.SettingsPlugin",
	HandlerType: (*SettingsPluginServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "ListSettings",
			Handler:    _SettingsPlugin_ListSettings_Handler,
		},
		{
			MethodName: "GetSetting",
			Handler:    _SettingsPlugin_GetSetting_Handler,
		},
		{
			MethodName: "GetSettingValue",
			Handler:    _SettingsPlugin_GetSettingValue_Handler,
		},
		{
			MethodName: "SetSetting",
			Handler:    _SettingsPlugin_SetSetting_Handler,
		},
		{
			MethodName: "SetSettings",
			Handler:    _SettingsPlugin_SetSettings_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "proto/v1/settings/settings.proto",
}

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

Functions

func RegisterSettingsPluginServer

func RegisterSettingsPluginServer(s grpc.ServiceRegistrar, srv SettingsPluginServer)

Types

type GetSettingRequest

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

func (*GetSettingRequest) Descriptor deprecated

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

Deprecated: Use GetSettingRequest.ProtoReflect.Descriptor instead.

func (*GetSettingRequest) GetId

func (x *GetSettingRequest) GetId() string

func (*GetSettingRequest) ProtoMessage

func (*GetSettingRequest) ProtoMessage()

func (*GetSettingRequest) ProtoReflect

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

func (*GetSettingRequest) Reset

func (x *GetSettingRequest) Reset()

func (*GetSettingRequest) String

func (x *GetSettingRequest) String() string

type GetSettingValueRequest

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

func (*GetSettingValueRequest) Descriptor deprecated

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

Deprecated: Use GetSettingValueRequest.ProtoReflect.Descriptor instead.

func (*GetSettingValueRequest) GetId

func (x *GetSettingValueRequest) GetId() string

func (*GetSettingValueRequest) ProtoMessage

func (*GetSettingValueRequest) ProtoMessage()

func (*GetSettingValueRequest) ProtoReflect

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

func (*GetSettingValueRequest) Reset

func (x *GetSettingValueRequest) Reset()

func (*GetSettingValueRequest) String

func (x *GetSettingValueRequest) String() string

type GetSettingValueResponse

type GetSettingValueResponse struct {
	Value *anypb.Any `protobuf:"bytes,1,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*GetSettingValueResponse) Descriptor deprecated

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

Deprecated: Use GetSettingValueResponse.ProtoReflect.Descriptor instead.

func (*GetSettingValueResponse) GetValue

func (x *GetSettingValueResponse) GetValue() *anypb.Any

func (*GetSettingValueResponse) ProtoMessage

func (*GetSettingValueResponse) ProtoMessage()

func (*GetSettingValueResponse) ProtoReflect

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

func (*GetSettingValueResponse) Reset

func (x *GetSettingValueResponse) Reset()

func (*GetSettingValueResponse) String

func (x *GetSettingValueResponse) String() string

type ListSettingsResponse

type ListSettingsResponse struct {
	Settings map[string]*Setting `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*ListSettingsResponse) Descriptor deprecated

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

Deprecated: Use ListSettingsResponse.ProtoReflect.Descriptor instead.

func (*ListSettingsResponse) GetSettings

func (x *ListSettingsResponse) GetSettings() map[string]*Setting

func (*ListSettingsResponse) ProtoMessage

func (*ListSettingsResponse) ProtoMessage()

func (*ListSettingsResponse) ProtoReflect

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

func (*ListSettingsResponse) Reset

func (x *ListSettingsResponse) Reset()

func (*ListSettingsResponse) String

func (x *ListSettingsResponse) String() string

type SetSettingRequest

type SetSettingRequest struct {
	Id    string     `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Value *anypb.Any `protobuf:"bytes,2,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*SetSettingRequest) Descriptor deprecated

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

Deprecated: Use SetSettingRequest.ProtoReflect.Descriptor instead.

func (*SetSettingRequest) GetId

func (x *SetSettingRequest) GetId() string

func (*SetSettingRequest) GetValue

func (x *SetSettingRequest) GetValue() *anypb.Any

func (*SetSettingRequest) ProtoMessage

func (*SetSettingRequest) ProtoMessage()

func (*SetSettingRequest) ProtoReflect

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

func (*SetSettingRequest) Reset

func (x *SetSettingRequest) Reset()

func (*SetSettingRequest) String

func (x *SetSettingRequest) String() string

type SetSettingsRequest

type SetSettingsRequest struct {
	Settings map[string]*anypb.Any `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*SetSettingsRequest) Descriptor deprecated

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

Deprecated: Use SetSettingsRequest.ProtoReflect.Descriptor instead.

func (*SetSettingsRequest) GetSettings

func (x *SetSettingsRequest) GetSettings() map[string]*anypb.Any

func (*SetSettingsRequest) ProtoMessage

func (*SetSettingsRequest) ProtoMessage()

func (*SetSettingsRequest) ProtoReflect

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

func (*SetSettingsRequest) Reset

func (x *SetSettingsRequest) Reset()

func (*SetSettingsRequest) String

func (x *SetSettingsRequest) String() string

type Setting

type Setting struct {
	Id            string                `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Label         string                `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	Description   string                `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Type          SettingType           `protobuf:"varint,4,opt,name=type,proto3,enum=omniview.sdk.settings.v1.SettingType" json:"type,omitempty"`
	Value         *anypb.Any            `protobuf:"bytes,5,opt,name=value,proto3" json:"value,omitempty"`
	Default       *anypb.Any            `protobuf:"bytes,6,opt,name=default,proto3" json:"default,omitempty"`
	Options       []*SettingOption      `protobuf:"bytes,7,rep,name=options,proto3" json:"options,omitempty"`
	FileSelection *SettingFileSelection `protobuf:"bytes,8,opt,name=file_selection,json=fileSelection,proto3,oneof" json:"file_selection,omitempty"`
	DevOnly       bool                  `protobuf:"varint,9,opt,name=dev_only,json=devOnly,proto3" json:"dev_only,omitempty"`
	// contains filtered or unexported fields
}

func (*Setting) Descriptor deprecated

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

Deprecated: Use Setting.ProtoReflect.Descriptor instead.

func (*Setting) GetDefault

func (x *Setting) GetDefault() *anypb.Any

func (*Setting) GetDescription

func (x *Setting) GetDescription() string

func (*Setting) GetDevOnly added in v0.4.1

func (x *Setting) GetDevOnly() bool

func (*Setting) GetFileSelection

func (x *Setting) GetFileSelection() *SettingFileSelection

func (*Setting) GetId

func (x *Setting) GetId() string

func (*Setting) GetLabel

func (x *Setting) GetLabel() string

func (*Setting) GetOptions

func (x *Setting) GetOptions() []*SettingOption

func (*Setting) GetType

func (x *Setting) GetType() SettingType

func (*Setting) GetValue

func (x *Setting) GetValue() *anypb.Any

func (*Setting) ProtoMessage

func (*Setting) ProtoMessage()

func (*Setting) ProtoReflect

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

func (*Setting) Reset

func (x *Setting) Reset()

func (*Setting) String

func (x *Setting) String() string

type SettingFileSelection

type SettingFileSelection struct {
	Enabled      bool     `protobuf:"varint,1,opt,name=enabled,proto3" json:"enabled,omitempty"`
	AllowFolders bool     `protobuf:"varint,2,opt,name=allow_folders,json=allowFolders,proto3" json:"allow_folders,omitempty"`
	Extensions   []string `protobuf:"bytes,3,rep,name=extensions,proto3" json:"extensions,omitempty"`
	Multiple     bool     `protobuf:"varint,4,opt,name=multiple,proto3" json:"multiple,omitempty"`
	Relative     bool     `protobuf:"varint,5,opt,name=relative,proto3" json:"relative,omitempty"`
	DefaultPath  string   `protobuf:"bytes,6,opt,name=default_path,json=defaultPath,proto3" json:"default_path,omitempty"`
	// contains filtered or unexported fields
}

func (*SettingFileSelection) Descriptor deprecated

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

Deprecated: Use SettingFileSelection.ProtoReflect.Descriptor instead.

func (*SettingFileSelection) GetAllowFolders

func (x *SettingFileSelection) GetAllowFolders() bool

func (*SettingFileSelection) GetDefaultPath

func (x *SettingFileSelection) GetDefaultPath() string

func (*SettingFileSelection) GetEnabled

func (x *SettingFileSelection) GetEnabled() bool

func (*SettingFileSelection) GetExtensions

func (x *SettingFileSelection) GetExtensions() []string

func (*SettingFileSelection) GetMultiple

func (x *SettingFileSelection) GetMultiple() bool

func (*SettingFileSelection) GetRelative

func (x *SettingFileSelection) GetRelative() bool

func (*SettingFileSelection) ProtoMessage

func (*SettingFileSelection) ProtoMessage()

func (*SettingFileSelection) ProtoReflect

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

func (*SettingFileSelection) Reset

func (x *SettingFileSelection) Reset()

func (*SettingFileSelection) String

func (x *SettingFileSelection) String() string

type SettingOption

type SettingOption struct {
	Label       string     `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"`
	Description string     `protobuf:"bytes,2,opt,name=description,proto3" json:"description,omitempty"`
	Value       *anypb.Any `protobuf:"bytes,3,opt,name=value,proto3" json:"value,omitempty"`
	// contains filtered or unexported fields
}

func (*SettingOption) Descriptor deprecated

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

Deprecated: Use SettingOption.ProtoReflect.Descriptor instead.

func (*SettingOption) GetDescription

func (x *SettingOption) GetDescription() string

func (*SettingOption) GetLabel

func (x *SettingOption) GetLabel() string

func (*SettingOption) GetValue

func (x *SettingOption) GetValue() *anypb.Any

func (*SettingOption) ProtoMessage

func (*SettingOption) ProtoMessage()

func (*SettingOption) ProtoReflect

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

func (*SettingOption) Reset

func (x *SettingOption) Reset()

func (*SettingOption) String

func (x *SettingOption) String() string

type SettingType

type SettingType int32
const (
	SettingType_SETTING_TYPE_TEXT         SettingType = 0
	SettingType_SETTING_TYPE_SELECT       SettingType = 1
	SettingType_SETTING_TYPE_MULTI_SELECT SettingType = 2
	SettingType_SETTING_TYPE_INTEGER      SettingType = 3
	SettingType_SETTING_TYPE_FLOAT        SettingType = 4
	SettingType_SETTING_TYPE_TOGGLE       SettingType = 5
	SettingType_SETTING_TYPE_COLOR        SettingType = 6
	SettingType_SETTING_TYPE_DATETIME     SettingType = 7
	SettingType_SETTING_TYPE_PASSWORD     SettingType = 8
)

func (SettingType) Descriptor

func (SettingType) Enum

func (x SettingType) Enum() *SettingType

func (SettingType) EnumDescriptor deprecated

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

Deprecated: Use SettingType.Descriptor instead.

func (SettingType) Number

func (x SettingType) Number() protoreflect.EnumNumber

func (SettingType) String

func (x SettingType) String() string

func (SettingType) Type

type SettingsCategory

type SettingsCategory struct {
	Id          string              `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	Label       string              `protobuf:"bytes,2,opt,name=label,proto3" json:"label,omitempty"`
	Description string              `protobuf:"bytes,3,opt,name=description,proto3" json:"description,omitempty"`
	Icon        string              `protobuf:"bytes,4,opt,name=icon,proto3" json:"icon,omitempty"`
	Settings    map[string]*Setting `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

func (*SettingsCategory) Descriptor deprecated

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

Deprecated: Use SettingsCategory.ProtoReflect.Descriptor instead.

func (*SettingsCategory) GetDescription

func (x *SettingsCategory) GetDescription() string

func (*SettingsCategory) GetIcon

func (x *SettingsCategory) GetIcon() string

func (*SettingsCategory) GetId

func (x *SettingsCategory) GetId() string

func (*SettingsCategory) GetLabel

func (x *SettingsCategory) GetLabel() string

func (*SettingsCategory) GetSettings

func (x *SettingsCategory) GetSettings() map[string]*Setting

func (*SettingsCategory) ProtoMessage

func (*SettingsCategory) ProtoMessage()

func (*SettingsCategory) ProtoReflect

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

func (*SettingsCategory) Reset

func (x *SettingsCategory) Reset()

func (*SettingsCategory) String

func (x *SettingsCategory) String() string

type SettingsPluginClient

type SettingsPluginClient interface {
	ListSettings(ctx context.Context, in *emptypb.Empty, opts ...grpc.CallOption) (*ListSettingsResponse, error)
	GetSetting(ctx context.Context, in *GetSettingRequest, opts ...grpc.CallOption) (*Setting, error)
	GetSettingValue(ctx context.Context, in *GetSettingValueRequest, opts ...grpc.CallOption) (*GetSettingValueResponse, error)
	SetSetting(ctx context.Context, in *SetSettingRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
	SetSettings(ctx context.Context, in *SetSettingsRequest, opts ...grpc.CallOption) (*emptypb.Empty, error)
}

SettingsPluginClient is the client API for SettingsPlugin 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.

type SettingsPluginServer

SettingsPluginServer is the server API for SettingsPlugin service. All implementations should embed UnimplementedSettingsPluginServer for forward compatibility

type UnimplementedSettingsPluginServer

type UnimplementedSettingsPluginServer struct {
}

UnimplementedSettingsPluginServer should be embedded to have forward compatible implementations.

func (UnimplementedSettingsPluginServer) GetSetting

func (UnimplementedSettingsPluginServer) GetSettingValue

func (UnimplementedSettingsPluginServer) ListSettings

func (UnimplementedSettingsPluginServer) SetSetting

func (UnimplementedSettingsPluginServer) SetSettings

type UnsafeSettingsPluginServer

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

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

type VisualComponentList

type VisualComponentList struct {
	Resource []*VisualResourceComponent `protobuf:"bytes,1,rep,name=resource,proto3" json:"resource,omitempty"`
	// contains filtered or unexported fields
}

VisualComponentList is a list of all the visual components provided by the plugin, grouped by the section they are applicable to.

func (*VisualComponentList) Descriptor deprecated

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

Deprecated: Use VisualComponentList.ProtoReflect.Descriptor instead.

func (*VisualComponentList) GetResource

func (x *VisualComponentList) GetResource() []*VisualResourceComponent

func (*VisualComponentList) ProtoMessage

func (*VisualComponentList) ProtoMessage()

func (*VisualComponentList) ProtoReflect

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

func (*VisualComponentList) Reset

func (x *VisualComponentList) Reset()

func (*VisualComponentList) String

func (x *VisualComponentList) String() string

type VisualResourceComponent

type VisualResourceComponent struct {

	// The unique identifier of the component.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// The plugin for which this component is applicable.
	Plugin string `protobuf:"bytes,2,opt,name=plugin,proto3" json:"plugin,omitempty"`
	// The type of the component.
	Type VisualResourceComponent_ComponentType `` /* 130-byte string literal not displayed */
	// The resources for which this component is applicable.
	Resources []string `protobuf:"bytes,4,rep,name=resources,proto3" json:"resources,omitempty"`
	// contains filtered or unexported fields
}

VisualResourceComponent is a visual component that can be displayed in the UI within a resource.

func (*VisualResourceComponent) Descriptor deprecated

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

Deprecated: Use VisualResourceComponent.ProtoReflect.Descriptor instead.

func (*VisualResourceComponent) GetId

func (x *VisualResourceComponent) GetId() string

func (*VisualResourceComponent) GetPlugin

func (x *VisualResourceComponent) GetPlugin() string

func (*VisualResourceComponent) GetResources

func (x *VisualResourceComponent) GetResources() []string

func (*VisualResourceComponent) GetType

func (*VisualResourceComponent) ProtoMessage

func (*VisualResourceComponent) ProtoMessage()

func (*VisualResourceComponent) ProtoReflect

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

func (*VisualResourceComponent) Reset

func (x *VisualResourceComponent) Reset()

func (*VisualResourceComponent) String

func (x *VisualResourceComponent) String() string

type VisualResourceComponent_ComponentType

type VisualResourceComponent_ComponentType int32
const (
	VisualResourceComponent_SIDEBAR    VisualResourceComponent_ComponentType = 0
	VisualResourceComponent_TABLE      VisualResourceComponent_ComponentType = 1
	VisualResourceComponent_TABLE_ROW  VisualResourceComponent_ComponentType = 2
	VisualResourceComponent_TABLE_CELL VisualResourceComponent_ComponentType = 3
)

func (VisualResourceComponent_ComponentType) Descriptor

func (VisualResourceComponent_ComponentType) Enum

func (VisualResourceComponent_ComponentType) EnumDescriptor deprecated

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

Deprecated: Use VisualResourceComponent_ComponentType.Descriptor instead.

func (VisualResourceComponent_ComponentType) Number

func (VisualResourceComponent_ComponentType) String

func (VisualResourceComponent_ComponentType) Type

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL