openconfig

package
v0.8.3 Latest Latest
Warning

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

 Go to latest Published: Nov 27, 2021 License: Apache-2.0 Imports: 5 Imported by: 4

Documentation

Overview

Package openconfig is a generated protocol buffer package.

It is generated from these files: 

openconfig.proto

It has these top-level messages: 

ExecRequest
ExecReply
RegisterRequest
RegisterReply
RegisterModuleRequest
RegisterModuleReply
ExecModuleRequest
ExecModuleReply
SubscribeRequest
ConfigRequest
ConfigReply
ShowRequest
ShowReply

Index

Constants

This section is empty.

Variables

View Source 
var ConfigType_name = map[int32]string{
	0:  "SET",
	1:  "DELETE",
	2:  "VALIDATE_START",
	3:  "VALIDATE_END",
	4:  "VALIDATE_SUCCESS",
	5:  "VALIDATE_FAILED",
	6:  "COMMIT_START",
	7:  "COMMIT_END",
	8:  "SUBSCRIBE",
	9:  "SUBSCRIBE_MULTI",
	10: "SUBSCRIBE_REQUEST",
	11: "JSON_CONFIG",
	12: "API_CALL_FINISHED",
}
View Source 
var ConfigType_value = map[string]int32{
	"SET":               0,
	"DELETE":            1,
	"VALIDATE_START":    2,
	"VALIDATE_END":      3,
	"VALIDATE_SUCCESS":  4,
	"VALIDATE_FAILED":   5,
	"COMMIT_START":      6,
	"COMMIT_END":        7,
	"SUBSCRIBE":         8,
	"SUBSCRIBE_MULTI":   9,
	"SUBSCRIBE_REQUEST": 10,
	"JSON_CONFIG":       11,
	"API_CALL_FINISHED": 12,
}
View Source 
var ExecCode_name = map[int32]string{
	0: "SUCCESS",
	1: "NOMATCH",
	2: "INCOMPLETE",
	3: "AMBIGUOUS",
	4: "SHOW",
	5: "REDIRECT",
	6: "REDIRECT_SHOW",
}
View Source 
var ExecCode_value = map[string]int32{
	"SUCCESS":       0,
	"NOMATCH":       1,
	"INCOMPLETE":    2,
	"AMBIGUOUS":     3,
	"SHOW":          4,
	"REDIRECT":      5,
	"REDIRECT_SHOW": 6,
}
View Source 
var ExecConentType_name = map[int32]string{
	0: "CONTENT_TEXT",
	1: "CONTENT_JSON",
}
View Source 
var ExecConentType_value = map[string]int32{
	"CONTENT_TEXT": 0,
	"CONTENT_JSON": 1,
}
View Source 
var ExecType_name = map[int32]string{
	0: "EXEC",
	1: "COMPLETE",
	2: "COMPLETE_TRAILING_SPACE",
	3: "COMPLETE_FIRST_COMMANDS",
	4: "COMPLETE_DYNAMIC",
}
View Source 
var ExecType_value = map[string]int32{
	"EXEC":                    0,
	"COMPLETE":                1,
	"COMPLETE_TRAILING_SPACE": 2,
	"COMPLETE_FIRST_COMMANDS": 3,
	"COMPLETE_DYNAMIC":        4,
}
View Source 
var SubscribeType_name = map[int32]string{
	0: "COMMAND",
	1: "JSON",
}
View Source 
var SubscribeType_value = map[string]int32{
	"COMMAND": 0,
	"JSON":    1,
}

Functions

func RegisterConfigServer 

func RegisterConfigServer(s *grpc.Server, srv ConfigServer)

func RegisterExecModuleServer 

func RegisterExecModuleServer(s *grpc.Server, srv ExecModuleServer)

func RegisterExecServer 

func RegisterExecServer(s *grpc.Server, srv ExecServer)

func RegisterRegisterServer 

func RegisterRegisterServer(s *grpc.Server, srv RegisterServer)

func RegisterShowServer 

func RegisterShowServer(s *grpc.Server, srv ShowServer)

Types

type ConfigClient 

type ConfigClient interface {
	DoConfig(ctx context.Context, opts ...grpc.CallOption) (Config_DoConfigClient, error)
}

func NewConfigClient 

func NewConfigClient(cc *grpc.ClientConn) ConfigClient

type ConfigReply 

type ConfigReply struct {
	Result int32      `protobuf:"varint,1,opt,name=result" json:"result,omitempty"`
	Type   ConfigType `protobuf:"varint,2,opt,name=type,enum=openconfig.ConfigType" json:"type,omitempty"`
	Path   []string   `protobuf:"bytes,3,rep,name=path" json:"path,omitempty"`
	Json   string     `protobuf:"bytes,4,opt,name=json" json:"json,omitempty"`
}

func (*ConfigReply) Descriptor 

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

func (*ConfigReply) GetJson added in v0.8.1 

func (m *ConfigReply) GetJson() string

func (*ConfigReply) GetPath 

func (m *ConfigReply) GetPath() []string

func (*ConfigReply) GetResult 

func (m *ConfigReply) GetResult() int32

func (*ConfigReply) GetType 

func (m *ConfigReply) GetType() ConfigType

func (*ConfigReply) ProtoMessage 

func (*ConfigReply) ProtoMessage()

func (*ConfigReply) Reset 

func (m *ConfigReply) Reset()

func (*ConfigReply) String 

func (m *ConfigReply) String() string

type ConfigRequest 

type ConfigRequest struct {
	Type      ConfigType          `protobuf:"varint,1,opt,name=type,enum=openconfig.ConfigType" json:"type,omitempty"`
	Module    string              `protobuf:"bytes,2,opt,name=module" json:"module,omitempty"`
	Host      string              `protobuf:"bytes,3,opt,name=host" json:"host,omitempty"`
	Port      uint32              `protobuf:"varint,4,opt,name=port" json:"port,omitempty"`
	Subtype   SubscribeType       `protobuf:"varint,5,opt,name=subtype,enum=openconfig.SubscribeType" json:"subtype,omitempty"`
	Path      []string            `protobuf:"bytes,6,rep,name=path" json:"path,omitempty"`
	Subscribe []*SubscribeRequest `protobuf:"bytes,7,rep,name=subscribe" json:"subscribe,omitempty"`
}

func (*ConfigRequest) Descriptor 

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

func (*ConfigRequest) GetHost added in v0.8.3 

func (m *ConfigRequest) GetHost() string

func (*ConfigRequest) GetModule 

func (m *ConfigRequest) GetModule() string

func (*ConfigRequest) GetPath 

func (m *ConfigRequest) GetPath() []string

func (*ConfigRequest) GetPort 

func (m *ConfigRequest) GetPort() uint32

func (*ConfigRequest) GetSubscribe added in v0.8.1 

func (m *ConfigRequest) GetSubscribe() []*SubscribeRequest

func (*ConfigRequest) GetSubtype 

func (m *ConfigRequest) GetSubtype() SubscribeType

func (*ConfigRequest) GetType 

func (m *ConfigRequest) GetType() ConfigType

func (*ConfigRequest) ProtoMessage 

func (*ConfigRequest) ProtoMessage()

func (*ConfigRequest) Reset 

func (m *ConfigRequest) Reset()

func (*ConfigRequest) String 

func (m *ConfigRequest) String() string

type ConfigServer 

type ConfigServer interface {
	DoConfig(Config_DoConfigServer) error
}

type ConfigType 

type ConfigType int32

Configuration service 

const (
	ConfigType_SET               ConfigType = 0
	ConfigType_DELETE            ConfigType = 1
	ConfigType_VALIDATE_START    ConfigType = 2
	ConfigType_VALIDATE_END      ConfigType = 3
	ConfigType_VALIDATE_SUCCESS  ConfigType = 4
	ConfigType_VALIDATE_FAILED   ConfigType = 5
	ConfigType_COMMIT_START      ConfigType = 6
	ConfigType_COMMIT_END        ConfigType = 7
	ConfigType_SUBSCRIBE         ConfigType = 8
	ConfigType_SUBSCRIBE_MULTI   ConfigType = 9
	ConfigType_SUBSCRIBE_REQUEST ConfigType = 10
	ConfigType_JSON_CONFIG       ConfigType = 11
	ConfigType_API_CALL_FINISHED ConfigType = 12
)

func (ConfigType) EnumDescriptor 

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

func (ConfigType) String 

func (x ConfigType) String() string

type Config_DoConfigClient 

type Config_DoConfigClient interface {
	Send(*ConfigRequest) error
	Recv() (*ConfigReply, error)
	grpc.ClientStream
}

type Config_DoConfigServer 

type Config_DoConfigServer interface {
	Send(*ConfigReply) error
	Recv() (*ConfigRequest, error)
	grpc.ServerStream
}

type ExecClient 

type ExecClient interface {
	DoExec(ctx context.Context, in *ExecRequest, opts ...grpc.CallOption) (*ExecReply, error)
}

func NewExecClient 

func NewExecClient(cc *grpc.ClientConn) ExecClient

type ExecCode 

type ExecCode int32

Command exec code. 

const (
	ExecCode_SUCCESS       ExecCode = 0
	ExecCode_NOMATCH       ExecCode = 1
	ExecCode_INCOMPLETE    ExecCode = 2
	ExecCode_AMBIGUOUS     ExecCode = 3
	ExecCode_SHOW          ExecCode = 4
	ExecCode_REDIRECT      ExecCode = 5
	ExecCode_REDIRECT_SHOW ExecCode = 6
)

func (ExecCode) EnumDescriptor 

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

func (ExecCode) String 

func (x ExecCode) String() string

type ExecConentType 

type ExecConentType int32

Command reply format type. 

const (
	ExecConentType_CONTENT_TEXT ExecConentType = 0
	ExecConentType_CONTENT_JSON ExecConentType = 1
)

func (ExecConentType) EnumDescriptor 

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

func (ExecConentType) String 

func (x ExecConentType) String() string

type ExecModuleClient 

type ExecModuleClient interface {
	DoExecModule(ctx context.Context, in *ExecModuleRequest, opts ...grpc.CallOption) (*ExecModuleReply, error)
}

func NewExecModuleClient 

func NewExecModuleClient(cc *grpc.ClientConn) ExecModuleClient

type ExecModuleReply 

type ExecModuleReply struct {
	Result int32  `protobuf:"varint,1,opt,name=result" json:"result,omitempty"`
	Line   string `protobuf:"bytes,2,opt,name=line" json:"line,omitempty"`
}

The response message containing the callbackID for the mode change.

func (*ExecModuleReply) Descriptor 

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

func (*ExecModuleReply) GetLine 

func (m *ExecModuleReply) GetLine() string

func (*ExecModuleReply) GetResult 

func (m *ExecModuleReply) GetResult() int32

func (*ExecModuleReply) ProtoMessage 

func (*ExecModuleReply) ProtoMessage()

func (*ExecModuleReply) Reset 

func (m *ExecModuleReply) Reset()

func (*ExecModuleReply) String 

func (m *ExecModuleReply) String() string

type ExecModuleRequest 

type ExecModuleRequest struct {
	Callbackid int32    `protobuf:"varint,1,opt,name=callbackid" json:"callbackid,omitempty"`
	Args       []string `protobuf:"bytes,2,rep,name=args" json:"args,omitempty"`
}

The request message mode information.

func (*ExecModuleRequest) Descriptor 

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

func (*ExecModuleRequest) GetArgs 

func (m *ExecModuleRequest) GetArgs() []string

func (*ExecModuleRequest) GetCallbackid 

func (m *ExecModuleRequest) GetCallbackid() int32

func (*ExecModuleRequest) ProtoMessage 

func (*ExecModuleRequest) ProtoMessage()

func (*ExecModuleRequest) Reset 

func (m *ExecModuleRequest) Reset()

func (*ExecModuleRequest) String 

func (m *ExecModuleRequest) String() string

type ExecModuleServer 

type ExecModuleServer interface {
	DoExecModule(context.Context, *ExecModuleRequest) (*ExecModuleReply, error)
}

type ExecReply 

type ExecReply struct {
	Code       ExecCode `protobuf:"varint,1,opt,name=code,enum=openconfig.ExecCode" json:"code,omitempty"`
	Lines      string   `protobuf:"bytes,2,opt,name=lines" json:"lines,omitempty"`
	Host       string   `protobuf:"bytes,3,opt,name=host" json:"host,omitempty"`
	Port       uint32   `protobuf:"varint,4,opt,name=port" json:"port,omitempty"`
	Candidates []string `protobuf:"bytes,5,rep,name=candidates" json:"candidates,omitempty"`
}

The response message containing the completion with help.

func (*ExecReply) Descriptor 

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

func (*ExecReply) GetCandidates 

func (m *ExecReply) GetCandidates() []string

func (*ExecReply) GetCode 

func (m *ExecReply) GetCode() ExecCode

func (*ExecReply) GetHost added in v0.8.3 

func (m *ExecReply) GetHost() string

func (*ExecReply) GetLines 

func (m *ExecReply) GetLines() string

func (*ExecReply) GetPort 

func (m *ExecReply) GetPort() uint32

func (*ExecReply) ProtoMessage 

func (*ExecReply) ProtoMessage()

func (*ExecReply) Reset 

func (m *ExecReply) Reset()

func (*ExecReply) String 

func (m *ExecReply) String() string

type ExecRequest 

type ExecRequest struct {
	Type      ExecType       `protobuf:"varint,1,opt,name=type,enum=openconfig.ExecType" json:"type,omitempty"`
	Mode      string         `protobuf:"bytes,2,opt,name=mode" json:"mode,omitempty"`
	Privilege uint32         `protobuf:"varint,3,opt,name=privilege" json:"privilege,omitempty"`
	Line      string         `protobuf:"bytes,4,opt,name=line" json:"line,omitempty"`
	Commands  []string       `protobuf:"bytes,5,rep,name=commands" json:"commands,omitempty"`
	Args      []string       `protobuf:"bytes,6,rep,name=args" json:"args,omitempty"`
	Content   ExecConentType `protobuf:"varint,7,opt,name=content,enum=openconfig.ExecConentType" json:"content,omitempty"`
}

The request message containing user input string.

func (*ExecRequest) Descriptor 

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

func (*ExecRequest) GetArgs 

func (m *ExecRequest) GetArgs() []string

func (*ExecRequest) GetCommands 

func (m *ExecRequest) GetCommands() []string

func (*ExecRequest) GetContent 

func (m *ExecRequest) GetContent() ExecConentType

func (*ExecRequest) GetLine 

func (m *ExecRequest) GetLine() string

func (*ExecRequest) GetMode 

func (m *ExecRequest) GetMode() string

func (*ExecRequest) GetPrivilege 

func (m *ExecRequest) GetPrivilege() uint32

func (*ExecRequest) GetType 

func (m *ExecRequest) GetType() ExecType

func (*ExecRequest) ProtoMessage 

func (*ExecRequest) ProtoMessage()

func (*ExecRequest) Reset 

func (m *ExecRequest) Reset()

func (*ExecRequest) String 

func (m *ExecRequest) String() string

type ExecServer 

type ExecServer interface {
	DoExec(context.Context, *ExecRequest) (*ExecReply, error)
}

type ExecType 

type ExecType int32

Command message type. 

const (
	ExecType_EXEC                    ExecType = 0
	ExecType_COMPLETE                ExecType = 1
	ExecType_COMPLETE_TRAILING_SPACE ExecType = 2
	ExecType_COMPLETE_FIRST_COMMANDS ExecType = 3
	ExecType_COMPLETE_DYNAMIC        ExecType = 4
)

func (ExecType) EnumDescriptor 

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

func (ExecType) String 

func (x ExecType) String() string

type RegisterClient 

type RegisterClient interface {
	DoRegister(ctx context.Context, in *RegisterRequest, opts ...grpc.CallOption) (*RegisterReply, error)
	DoRegisterModule(ctx context.Context, in *RegisterModuleRequest, opts ...grpc.CallOption) (*RegisterModuleReply, error)
}

func NewRegisterClient 

func NewRegisterClient(cc *grpc.ClientConn) RegisterClient

type RegisterModuleReply 

type RegisterModuleReply struct {
	Result int32 `protobuf:"varint,1,opt,name=result" json:"result,omitempty"`
}

The response message containing the callbackID for the mode change.

func (*RegisterModuleReply) Descriptor 

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

func (*RegisterModuleReply) GetResult 

func (m *RegisterModuleReply) GetResult() int32

func (*RegisterModuleReply) ProtoMessage 

func (*RegisterModuleReply) ProtoMessage()

func (*RegisterModuleReply) Reset 

func (m *RegisterModuleReply) Reset()

func (*RegisterModuleReply) String 

func (m *RegisterModuleReply) String() string

type RegisterModuleRequest 

type RegisterModuleRequest struct {
	Module string `protobuf:"bytes,1,opt,name=module" json:"module,omitempty"`
	Host   string `protobuf:"bytes,2,opt,name=host" json:"host,omitempty"`
	Port   string `protobuf:"bytes,3,opt,name=port" json:"port,omitempty"`
}

The request message mode information.

func (*RegisterModuleRequest) Descriptor 

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

func (*RegisterModuleRequest) GetHost added in v0.8.3 

func (m *RegisterModuleRequest) GetHost() string

func (*RegisterModuleRequest) GetModule 

func (m *RegisterModuleRequest) GetModule() string

func (*RegisterModuleRequest) GetPort 

func (m *RegisterModuleRequest) GetPort() string

func (*RegisterModuleRequest) ProtoMessage 

func (*RegisterModuleRequest) ProtoMessage()

func (*RegisterModuleRequest) Reset 

func (m *RegisterModuleRequest) Reset()

func (*RegisterModuleRequest) String 

func (m *RegisterModuleRequest) String() string

type RegisterReply 

type RegisterReply struct {
	Callbackid int32 `protobuf:"varint,1,opt,name=callbackid" json:"callbackid,omitempty"`
}

The response message for callback ID.

func (*RegisterReply) Descriptor 

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

func (*RegisterReply) GetCallbackid 

func (m *RegisterReply) GetCallbackid() int32

func (*RegisterReply) ProtoMessage 

func (*RegisterReply) ProtoMessage()

func (*RegisterReply) Reset 

func (m *RegisterReply) Reset()

func (*RegisterReply) String 

func (m *RegisterReply) String() string

type RegisterRequest 

type RegisterRequest struct {
	Name      string   `protobuf:"bytes,1,opt,name=name" json:"name,omitempty"`
	Module    string   `protobuf:"bytes,2,opt,name=module" json:"module,omitempty"`
	Mode      string   `protobuf:"bytes,3,opt,name=mode" json:"mode,omitempty"`
	Line      string   `protobuf:"bytes,4,opt,name=line" json:"line,omitempty"`
	Privilege uint32   `protobuf:"varint,5,opt,name=privilege" json:"privilege,omitempty"`
	Helps     []string `protobuf:"bytes,6,rep,name=helps" json:"helps,omitempty"`
	Code      ExecCode `protobuf:"varint,7,opt,name=code,enum=openconfig.ExecCode" json:"code,omitempty"`
}

The request message for command definition.

func (*RegisterRequest) Descriptor 

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

func (*RegisterRequest) GetCode 

func (m *RegisterRequest) GetCode() ExecCode

func (*RegisterRequest) GetHelps 

func (m *RegisterRequest) GetHelps() []string

func (*RegisterRequest) GetLine 

func (m *RegisterRequest) GetLine() string

func (*RegisterRequest) GetMode 

func (m *RegisterRequest) GetMode() string

func (*RegisterRequest) GetModule 

func (m *RegisterRequest) GetModule() string

func (*RegisterRequest) GetName 

func (m *RegisterRequest) GetName() string

func (*RegisterRequest) GetPrivilege 

func (m *RegisterRequest) GetPrivilege() uint32

func (*RegisterRequest) ProtoMessage 

func (*RegisterRequest) ProtoMessage()

func (*RegisterRequest) Reset 

func (m *RegisterRequest) Reset()

func (*RegisterRequest) String 

func (m *RegisterRequest) String() string

type RegisterServer 

type RegisterServer interface {
	DoRegister(context.Context, *RegisterRequest) (*RegisterReply, error)
	DoRegisterModule(context.Context, *RegisterModuleRequest) (*RegisterModuleReply, error)
}

type ShowClient 

type ShowClient interface {
	Show(ctx context.Context, in *ShowRequest, opts ...grpc.CallOption) (Show_ShowClient, error)
}

func NewShowClient 

func NewShowClient(cc *grpc.ClientConn) ShowClient

type ShowReply 

type ShowReply struct {
	Str string `protobuf:"bytes,1,opt,name=str" json:"str,omitempty"`
}

func (*ShowReply) Descriptor 

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

func (*ShowReply) GetStr 

func (m *ShowReply) GetStr() string

func (*ShowReply) ProtoMessage 

func (*ShowReply) ProtoMessage()

func (*ShowReply) Reset 

func (m *ShowReply) Reset()

func (*ShowReply) String 

func (m *ShowReply) String() string

type ShowRequest 

type ShowRequest struct {
	Line string `protobuf:"bytes,1,opt,name=line" json:"line,omitempty"`
	Json bool   `protobuf:"varint,2,opt,name=json" json:"json,omitempty"`
}

Show service.

func (*ShowRequest) Descriptor 

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

func (*ShowRequest) GetJson 

func (m *ShowRequest) GetJson() bool

func (*ShowRequest) GetLine 

func (m *ShowRequest) GetLine() string

func (*ShowRequest) ProtoMessage 

func (*ShowRequest) ProtoMessage()

func (*ShowRequest) Reset 

func (m *ShowRequest) Reset()

func (*ShowRequest) String 

func (m *ShowRequest) String() string

type ShowServer 

type ShowServer interface {
	Show(*ShowRequest, Show_ShowServer) error
}

type Show_ShowClient 

type Show_ShowClient interface {
	Recv() (*ShowReply, error)
	grpc.ClientStream
}

type Show_ShowServer 

type Show_ShowServer interface {
	Send(*ShowReply) error
	grpc.ServerStream
}

type SubscribeRequest added in v0.8.1 

type SubscribeRequest struct {
	Type SubscribeType `protobuf:"varint,1,opt,name=type,enum=openconfig.SubscribeType" json:"type,omitempty"`
	Path string        `protobuf:"bytes,2,opt,name=path" json:"path,omitempty"`
}

func (*SubscribeRequest) Descriptor added in v0.8.1 

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

func (*SubscribeRequest) GetPath added in v0.8.1 

func (m *SubscribeRequest) GetPath() string

func (*SubscribeRequest) GetType added in v0.8.1 

func (m *SubscribeRequest) GetType() SubscribeType

func (*SubscribeRequest) ProtoMessage added in v0.8.1 

func (*SubscribeRequest) ProtoMessage()

func (*SubscribeRequest) Reset added in v0.8.1 

func (m *SubscribeRequest) Reset()

func (*SubscribeRequest) String added in v0.8.1 

func (m *SubscribeRequest) String() string

type SubscribeType 

type SubscribeType int32

Subscribe type. 

const (
	SubscribeType_COMMAND SubscribeType = 0
	SubscribeType_JSON    SubscribeType = 1
)

func (SubscribeType) EnumDescriptor 

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

func (SubscribeType) String 

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