Documentation
¶
Index ¶
- Variables
- func RegisterConfigAdminServiceServer(s *grpc.Server, srv ConfigAdminServiceServer)
- type Chunk
- func (*Chunk) Descriptor() ([]byte, []int)
- func (m *Chunk) GetContent() []byte
- func (m *Chunk) GetSoFile() string
- func (*Chunk) ProtoMessage()
- func (m *Chunk) Reset()
- func (m *Chunk) String() string
- func (m *Chunk) XXX_DiscardUnknown()
- func (m *Chunk) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *Chunk) XXX_Merge(src proto.Message)
- func (m *Chunk) XXX_Size() int
- func (m *Chunk) XXX_Unmarshal(b []byte) error
- type CompactChangesRequest
- func (*CompactChangesRequest) Descriptor() ([]byte, []int)
- func (m *CompactChangesRequest) GetRetentionPeriod() *time.Duration
- func (*CompactChangesRequest) ProtoMessage()
- func (m *CompactChangesRequest) Reset()
- func (m *CompactChangesRequest) String() string
- func (m *CompactChangesRequest) XXX_DiscardUnknown()
- func (m *CompactChangesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CompactChangesRequest) XXX_Merge(src proto.Message)
- func (m *CompactChangesRequest) XXX_Size() int
- func (m *CompactChangesRequest) XXX_Unmarshal(b []byte) error
- type CompactChangesResponse
- func (*CompactChangesResponse) Descriptor() ([]byte, []int)
- func (*CompactChangesResponse) ProtoMessage()
- func (m *CompactChangesResponse) Reset()
- func (m *CompactChangesResponse) String() string
- func (m *CompactChangesResponse) XXX_DiscardUnknown()
- func (m *CompactChangesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *CompactChangesResponse) XXX_Merge(src proto.Message)
- func (m *CompactChangesResponse) XXX_Size() int
- func (m *CompactChangesResponse) XXX_Unmarshal(b []byte) error
- type ConfigAdminServiceClient
- type ConfigAdminServiceServer
- type ConfigAdminService_ListRegisteredModelsClient
- type ConfigAdminService_ListRegisteredModelsServer
- type ConfigAdminService_ListSnapshotsClient
- type ConfigAdminService_ListSnapshotsServer
- type ConfigAdminService_UploadRegisterModelClient
- type ConfigAdminService_UploadRegisterModelServer
- type ListModelsRequest
- func (*ListModelsRequest) Descriptor() ([]byte, []int)
- func (m *ListModelsRequest) GetModelName() string
- func (m *ListModelsRequest) GetModelVersion() string
- func (m *ListModelsRequest) GetVerbose() bool
- func (*ListModelsRequest) ProtoMessage()
- func (m *ListModelsRequest) Reset()
- func (m *ListModelsRequest) String() string
- func (m *ListModelsRequest) XXX_DiscardUnknown()
- func (m *ListModelsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListModelsRequest) XXX_Merge(src proto.Message)
- func (m *ListModelsRequest) XXX_Size() int
- func (m *ListModelsRequest) XXX_Unmarshal(b []byte) error
- type ListSnapshotsRequest
- func (*ListSnapshotsRequest) Descriptor() ([]byte, []int)
- func (m *ListSnapshotsRequest) GetID() github_com_onosproject_onos_config_api_types_snapshot_device.ID
- func (m *ListSnapshotsRequest) GetSubscribe() bool
- func (*ListSnapshotsRequest) ProtoMessage()
- func (m *ListSnapshotsRequest) Reset()
- func (m *ListSnapshotsRequest) String() string
- func (m *ListSnapshotsRequest) XXX_DiscardUnknown()
- func (m *ListSnapshotsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ListSnapshotsRequest) XXX_Merge(src proto.Message)
- func (m *ListSnapshotsRequest) XXX_Size() int
- func (m *ListSnapshotsRequest) XXX_Unmarshal(b []byte) error
- type ModelInfo
- func (*ModelInfo) Descriptor() ([]byte, []int)
- func (m *ModelInfo) GetGetStateMode() uint32
- func (m *ModelInfo) GetModelData() []*gnmi.ModelData
- func (m *ModelInfo) GetModule() string
- func (m *ModelInfo) GetName() string
- func (m *ModelInfo) GetReadOnlyPath() []*ReadOnlyPath
- func (m *ModelInfo) GetReadWritePath() []*ReadWritePath
- func (m *ModelInfo) GetVersion() string
- func (*ModelInfo) ProtoMessage()
- func (m *ModelInfo) Reset()
- func (m *ModelInfo) String() string
- func (m *ModelInfo) XXX_DiscardUnknown()
- func (m *ModelInfo) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ModelInfo) XXX_Merge(src proto.Message)
- func (m *ModelInfo) XXX_Size() int
- func (m *ModelInfo) XXX_Unmarshal(b []byte) error
- type ReadOnlyPath
- func (*ReadOnlyPath) Descriptor() ([]byte, []int)
- func (m *ReadOnlyPath) GetPath() string
- func (m *ReadOnlyPath) GetSubPath() []*ReadOnlySubPath
- func (*ReadOnlyPath) ProtoMessage()
- func (m *ReadOnlyPath) Reset()
- func (m *ReadOnlyPath) String() string
- func (m *ReadOnlyPath) XXX_DiscardUnknown()
- func (m *ReadOnlyPath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadOnlyPath) XXX_Merge(src proto.Message)
- func (m *ReadOnlyPath) XXX_Size() int
- func (m *ReadOnlyPath) XXX_Unmarshal(b []byte) error
- type ReadOnlySubPath
- func (*ReadOnlySubPath) Descriptor() ([]byte, []int)
- func (m *ReadOnlySubPath) GetSubPath() string
- func (m *ReadOnlySubPath) GetValueType() device.ValueType
- func (*ReadOnlySubPath) ProtoMessage()
- func (m *ReadOnlySubPath) Reset()
- func (m *ReadOnlySubPath) String() string
- func (m *ReadOnlySubPath) XXX_DiscardUnknown()
- func (m *ReadOnlySubPath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadOnlySubPath) XXX_Merge(src proto.Message)
- func (m *ReadOnlySubPath) XXX_Size() int
- func (m *ReadOnlySubPath) XXX_Unmarshal(b []byte) error
- type ReadWritePath
- func (*ReadWritePath) Descriptor() ([]byte, []int)
- func (m *ReadWritePath) GetDefault() string
- func (m *ReadWritePath) GetDescription() string
- func (m *ReadWritePath) GetLength() []string
- func (m *ReadWritePath) GetMandatory() bool
- func (m *ReadWritePath) GetPath() string
- func (m *ReadWritePath) GetRange() []string
- func (m *ReadWritePath) GetUnits() string
- func (m *ReadWritePath) GetValueType() device.ValueType
- func (*ReadWritePath) ProtoMessage()
- func (m *ReadWritePath) Reset()
- func (m *ReadWritePath) String() string
- func (m *ReadWritePath) XXX_DiscardUnknown()
- func (m *ReadWritePath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *ReadWritePath) XXX_Merge(src proto.Message)
- func (m *ReadWritePath) XXX_Size() int
- func (m *ReadWritePath) XXX_Unmarshal(b []byte) error
- type RegisterResponse
- func (*RegisterResponse) Descriptor() ([]byte, []int)
- func (m *RegisterResponse) GetName() string
- func (m *RegisterResponse) GetVersion() string
- func (*RegisterResponse) ProtoMessage()
- func (m *RegisterResponse) Reset()
- func (m *RegisterResponse) String() string
- func (m *RegisterResponse) XXX_DiscardUnknown()
- func (m *RegisterResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RegisterResponse) XXX_Merge(src proto.Message)
- func (m *RegisterResponse) XXX_Size() int
- func (m *RegisterResponse) XXX_Unmarshal(b []byte) error
- type RollbackRequest
- func (*RollbackRequest) Descriptor() ([]byte, []int)
- func (m *RollbackRequest) GetComment() string
- func (m *RollbackRequest) GetName() string
- func (*RollbackRequest) ProtoMessage()
- func (m *RollbackRequest) Reset()
- func (m *RollbackRequest) String() string
- func (m *RollbackRequest) XXX_DiscardUnknown()
- func (m *RollbackRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RollbackRequest) XXX_Merge(src proto.Message)
- func (m *RollbackRequest) XXX_Size() int
- func (m *RollbackRequest) XXX_Unmarshal(b []byte) error
- type RollbackResponse
- func (*RollbackResponse) Descriptor() ([]byte, []int)
- func (m *RollbackResponse) GetMessage() string
- func (*RollbackResponse) ProtoMessage()
- func (m *RollbackResponse) Reset()
- func (m *RollbackResponse) String() string
- func (m *RollbackResponse) XXX_DiscardUnknown()
- func (m *RollbackResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
- func (m *RollbackResponse) XXX_Merge(src proto.Message)
- func (m *RollbackResponse) XXX_Size() int
- func (m *RollbackResponse) XXX_Unmarshal(b []byte) error
- type Type
- type UnimplementedConfigAdminServiceServer
- func (*UnimplementedConfigAdminServiceServer) CompactChanges(ctx context.Context, req *CompactChangesRequest) (*CompactChangesResponse, error)
- func (*UnimplementedConfigAdminServiceServer) ListRegisteredModels(req *ListModelsRequest, srv ConfigAdminService_ListRegisteredModelsServer) error
- func (*UnimplementedConfigAdminServiceServer) ListSnapshots(req *ListSnapshotsRequest, srv ConfigAdminService_ListSnapshotsServer) error
- func (*UnimplementedConfigAdminServiceServer) RollbackNetworkChange(ctx context.Context, req *RollbackRequest) (*RollbackResponse, error)
- func (*UnimplementedConfigAdminServiceServer) UploadRegisterModel(srv ConfigAdminService_UploadRegisterModelServer) error
Constants ¶
This section is empty.
Variables ¶
var ConfigAdminClientFactory = func(cc *grpc.ClientConn) ConfigAdminServiceClient { return NewConfigAdminServiceClient(cc) }
ConfigAdminClientFactory : Default ConfigAdminClient creation.
var Type_name = map[int32]string{
0: "NONE",
1: "ADDED",
2: "UPDATED",
3: "REMOVED",
}
var Type_value = map[string]int32{
"NONE": 0,
"ADDED": 1,
"UPDATED": 2,
"REMOVED": 3,
}
Functions ¶
func RegisterConfigAdminServiceServer ¶
func RegisterConfigAdminServiceServer(s *grpc.Server, srv ConfigAdminServiceServer)
Types ¶
type Chunk ¶
type Chunk struct {
// so_file is the name being streamed.
SoFile string `protobuf:"bytes,1,opt,name=so_file,json=soFile,proto3" json:"so_file,omitempty"`
// content is the bytes content.
Content []byte `protobuf:"bytes,2,opt,name=content,proto3" json:"content,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
Chunk is for streaming a model plugin file to the server. There is a built in limit in gRPC of 4MB - plugin is usually around 20MB so break in to chunks of approx 1-2MB.
func (*Chunk) Descriptor ¶
func (*Chunk) GetContent ¶
func (*Chunk) ProtoMessage ¶
func (*Chunk) ProtoMessage()
func (*Chunk) XXX_DiscardUnknown ¶
func (m *Chunk) XXX_DiscardUnknown()
func (*Chunk) XXX_Marshal ¶
func (*Chunk) XXX_Unmarshal ¶
type CompactChangesRequest ¶
type CompactChangesRequest struct {
// retention_period is an optional duration of time counting back from the present moment
// Network changes that were created during this period should not be compacted
// Any network changes that are older should be compacted
// If not specified the duration is 0
RetentionPeriod *time.Duration `protobuf:"bytes,1,opt,name=retention_period,json=retentionPeriod,proto3,stdduration" json:"retention_period,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
CompactChangesRequest requests a compaction of the Network Change and Device Change stores
func (*CompactChangesRequest) Descriptor ¶
func (*CompactChangesRequest) Descriptor() ([]byte, []int)
func (*CompactChangesRequest) GetRetentionPeriod ¶
func (m *CompactChangesRequest) GetRetentionPeriod() *time.Duration
func (*CompactChangesRequest) ProtoMessage ¶
func (*CompactChangesRequest) ProtoMessage()
func (*CompactChangesRequest) Reset ¶
func (m *CompactChangesRequest) Reset()
func (*CompactChangesRequest) String ¶
func (m *CompactChangesRequest) String() string
func (*CompactChangesRequest) XXX_DiscardUnknown ¶
func (m *CompactChangesRequest) XXX_DiscardUnknown()
func (*CompactChangesRequest) XXX_Marshal ¶
func (m *CompactChangesRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CompactChangesRequest) XXX_Merge ¶
func (m *CompactChangesRequest) XXX_Merge(src proto.Message)
func (*CompactChangesRequest) XXX_Size ¶
func (m *CompactChangesRequest) XXX_Size() int
func (*CompactChangesRequest) XXX_Unmarshal ¶
func (m *CompactChangesRequest) XXX_Unmarshal(b []byte) error
type CompactChangesResponse ¶
type CompactChangesResponse struct {
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
CompactChangesResponse is a response to the Compact Changes command
func (*CompactChangesResponse) Descriptor ¶
func (*CompactChangesResponse) Descriptor() ([]byte, []int)
func (*CompactChangesResponse) ProtoMessage ¶
func (*CompactChangesResponse) ProtoMessage()
func (*CompactChangesResponse) Reset ¶
func (m *CompactChangesResponse) Reset()
func (*CompactChangesResponse) String ¶
func (m *CompactChangesResponse) String() string
func (*CompactChangesResponse) XXX_DiscardUnknown ¶
func (m *CompactChangesResponse) XXX_DiscardUnknown()
func (*CompactChangesResponse) XXX_Marshal ¶
func (m *CompactChangesResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*CompactChangesResponse) XXX_Merge ¶
func (m *CompactChangesResponse) XXX_Merge(src proto.Message)
func (*CompactChangesResponse) XXX_Size ¶
func (m *CompactChangesResponse) XXX_Size() int
func (*CompactChangesResponse) XXX_Unmarshal ¶
func (m *CompactChangesResponse) XXX_Unmarshal(b []byte) error
type ConfigAdminServiceClient ¶
type ConfigAdminServiceClient interface {
// UploadRegisterModel uploads and adds the model plugin to the list of supported models.
// The file is serialized in to Chunks of less than 4MB so as not to break the
// gRPC byte array limit
UploadRegisterModel(ctx context.Context, opts ...grpc.CallOption) (ConfigAdminService_UploadRegisterModelClient, error)
// ListRegisteredModels returns a stream of registered models.
ListRegisteredModels(ctx context.Context, in *ListModelsRequest, opts ...grpc.CallOption) (ConfigAdminService_ListRegisteredModelsClient, error)
// RollbackNetworkChange rolls back the specified network change (or the latest one).
RollbackNetworkChange(ctx context.Context, in *RollbackRequest, opts ...grpc.CallOption) (*RollbackResponse, error)
// ListSnapshots gets a list of snapshots across all devices and versions,
// and streams them back to the caller.
ListSnapshots(ctx context.Context, in *ListSnapshotsRequest, opts ...grpc.CallOption) (ConfigAdminService_ListSnapshotsClient, error)
// CompactChanges requests a snapshot of NetworkChange and DeviceChange stores.
// This will take all of the Network Changes older than the retention period and
// flatten them down to just one snapshot (replacing any older snapshot).
// This will act as a baseline for those changes within the retention period and any future changes.
// DeviceChanges will be snapshotted to correspond to these NetworkChange compactions
// leaving an individual snapshot perv device and version combination.
CompactChanges(ctx context.Context, in *CompactChangesRequest, opts ...grpc.CallOption) (*CompactChangesResponse, error)
}
ConfigAdminServiceClient is the client API for ConfigAdminService service.
For semantics around ctx use and closing/ending streaming RPCs, please refer to https://godoc.org/google.golang.org/grpc#ClientConn.NewStream.
func CreateConfigAdminServiceClient ¶
func CreateConfigAdminServiceClient(cc *grpc.ClientConn) ConfigAdminServiceClient
CreateConfigAdminServiceClient creates and returns a new config admin client
func NewConfigAdminServiceClient ¶
func NewConfigAdminServiceClient(cc *grpc.ClientConn) ConfigAdminServiceClient
type ConfigAdminServiceServer ¶
type ConfigAdminServiceServer interface {
// UploadRegisterModel uploads and adds the model plugin to the list of supported models.
// The file is serialized in to Chunks of less than 4MB so as not to break the
// gRPC byte array limit
UploadRegisterModel(ConfigAdminService_UploadRegisterModelServer) error
// ListRegisteredModels returns a stream of registered models.
ListRegisteredModels(*ListModelsRequest, ConfigAdminService_ListRegisteredModelsServer) error
// RollbackNetworkChange rolls back the specified network change (or the latest one).
RollbackNetworkChange(context.Context, *RollbackRequest) (*RollbackResponse, error)
// ListSnapshots gets a list of snapshots across all devices and versions,
// and streams them back to the caller.
ListSnapshots(*ListSnapshotsRequest, ConfigAdminService_ListSnapshotsServer) error
// CompactChanges requests a snapshot of NetworkChange and DeviceChange stores.
// This will take all of the Network Changes older than the retention period and
// flatten them down to just one snapshot (replacing any older snapshot).
// This will act as a baseline for those changes within the retention period and any future changes.
// DeviceChanges will be snapshotted to correspond to these NetworkChange compactions
// leaving an individual snapshot perv device and version combination.
CompactChanges(context.Context, *CompactChangesRequest) (*CompactChangesResponse, error)
}
ConfigAdminServiceServer is the server API for ConfigAdminService service.
type ConfigAdminService_ListRegisteredModelsClient ¶
type ConfigAdminService_ListRegisteredModelsClient interface {
Recv() (*ModelInfo, error)
grpc.ClientStream
}
type ConfigAdminService_ListRegisteredModelsServer ¶
type ConfigAdminService_ListRegisteredModelsServer interface {
Send(*ModelInfo) error
grpc.ServerStream
}
type ConfigAdminService_ListSnapshotsClient ¶
type ConfigAdminService_ListSnapshotsClient interface {
Recv() (*device1.Snapshot, error)
grpc.ClientStream
}
type ConfigAdminService_ListSnapshotsServer ¶
type ConfigAdminService_ListSnapshotsServer interface {
Send(*device1.Snapshot) error
grpc.ServerStream
}
type ConfigAdminService_UploadRegisterModelClient ¶
type ConfigAdminService_UploadRegisterModelClient interface {
Send(*Chunk) error
CloseAndRecv() (*RegisterResponse, error)
grpc.ClientStream
}
type ConfigAdminService_UploadRegisterModelServer ¶
type ConfigAdminService_UploadRegisterModelServer interface {
SendAndClose(*RegisterResponse) error
Recv() (*Chunk, error)
grpc.ServerStream
}
type ListModelsRequest ¶
type ListModelsRequest struct {
// verbose option causes all of the ReadWrite and ReadOnly paths to be included.
Verbose bool `protobuf:"varint,1,opt,name=verbose,proto3" json:"verbose,omitempty"`
// An optional filter on the name of the model plugins to list.
ModelName string `protobuf:"bytes,2,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"`
// An optional filter on the version of the model plugins to list
ModelVersion string `protobuf:"bytes,3,opt,name=model_version,json=modelVersion,proto3" json:"model_version,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ListModelsRequest carries data for querying registered model plugins.
func (*ListModelsRequest) Descriptor ¶
func (*ListModelsRequest) Descriptor() ([]byte, []int)
func (*ListModelsRequest) GetModelName ¶
func (m *ListModelsRequest) GetModelName() string
func (*ListModelsRequest) GetModelVersion ¶
func (m *ListModelsRequest) GetModelVersion() string
func (*ListModelsRequest) GetVerbose ¶
func (m *ListModelsRequest) GetVerbose() bool
func (*ListModelsRequest) ProtoMessage ¶
func (*ListModelsRequest) ProtoMessage()
func (*ListModelsRequest) Reset ¶
func (m *ListModelsRequest) Reset()
func (*ListModelsRequest) String ¶
func (m *ListModelsRequest) String() string
func (*ListModelsRequest) XXX_DiscardUnknown ¶
func (m *ListModelsRequest) XXX_DiscardUnknown()
func (*ListModelsRequest) XXX_Marshal ¶
func (m *ListModelsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListModelsRequest) XXX_Merge ¶
func (m *ListModelsRequest) XXX_Merge(src proto.Message)
func (*ListModelsRequest) XXX_Size ¶
func (m *ListModelsRequest) XXX_Size() int
func (*ListModelsRequest) XXX_Unmarshal ¶
func (m *ListModelsRequest) XXX_Unmarshal(b []byte) error
type ListSnapshotsRequest ¶
type ListSnapshotsRequest struct {
// subscribe indicates whether to subscribe to events (e.g. ADD, UPDATE, and REMOVE) that occur
// after all devices have been streamed to the client
Subscribe bool `protobuf:"varint,1,opt,name=subscribe,proto3" json:"subscribe,omitempty"`
// option to specify a specific device - if blank or '*' then select all
// Can support `*` (match many chars) or '?' (match one char) as wildcard
ID github_com_onosproject_onos_config_api_types_snapshot_device.ID `` /* 130-byte string literal not displayed */
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ListSnapshotsRequest requests a list of snapshots for all devices and versions.
func (*ListSnapshotsRequest) Descriptor ¶
func (*ListSnapshotsRequest) Descriptor() ([]byte, []int)
func (*ListSnapshotsRequest) GetSubscribe ¶
func (m *ListSnapshotsRequest) GetSubscribe() bool
func (*ListSnapshotsRequest) ProtoMessage ¶
func (*ListSnapshotsRequest) ProtoMessage()
func (*ListSnapshotsRequest) Reset ¶
func (m *ListSnapshotsRequest) Reset()
func (*ListSnapshotsRequest) String ¶
func (m *ListSnapshotsRequest) String() string
func (*ListSnapshotsRequest) XXX_DiscardUnknown ¶
func (m *ListSnapshotsRequest) XXX_DiscardUnknown()
func (*ListSnapshotsRequest) XXX_Marshal ¶
func (m *ListSnapshotsRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ListSnapshotsRequest) XXX_Merge ¶
func (m *ListSnapshotsRequest) XXX_Merge(src proto.Message)
func (*ListSnapshotsRequest) XXX_Size ¶
func (m *ListSnapshotsRequest) XXX_Size() int
func (*ListSnapshotsRequest) XXX_Unmarshal ¶
func (m *ListSnapshotsRequest) XXX_Unmarshal(b []byte) error
type ModelInfo ¶
type ModelInfo struct {
// name is the name given to the model plugin - no spaces and title case.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// version is the semantic version of the Plugin e.g. 1.0.0.
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
// model_data is a set of metadata about the YANG files that went in to
// generating the model plugin. It includes name, version and organization for
// each YANG file, similar to how they are represented in gNMI Capabilities.
ModelData []*gnmi.ModelData `protobuf:"bytes,3,rep,name=model_data,json=modelData,proto3" json:"model_data,omitempty"`
// module is the name of the Model Plugin on the file system - usually ending in .so.<version>.
Module string `protobuf:"bytes,4,opt,name=module,proto3" json:"module,omitempty"`
// getStateMode is flag that defines how the "get state" operation works.
// 0) means that no retrieval of state is attempted
// 1) means that the synchronizer will make 2 requests to the device - one for
// Get with State and another for Get with Operational.
// 2) means that the synchronizer will do a Get request comprising of each
// one of the ReadOnlyPaths and their sub paths. If there is a `list`
// in any one of these paths it will be sent down as is, expecting the
// devices implementation of gNMI will be able to expand wildcards.
// 3) means that the synchronizer will do a Get request comprising of each
// one of the ReadOnlyPaths and their sub paths. If there is a `list`
// in any one of these paths, a separate call will be made first to find
// all the instances in the list and a Get including these expanded wildcards
// will be sent down to the device.
GetStateMode uint32 `protobuf:"varint,5,opt,name=getStateMode,proto3" json:"getStateMode,omitempty"`
// read_only_path is all of the read only paths for the model plugin.
ReadOnlyPath []*ReadOnlyPath `protobuf:"bytes,7,rep,name=read_only_path,json=readOnlyPath,proto3" json:"read_only_path,omitempty"`
// read_write_path is all of the read write paths for the model plugin.
ReadWritePath []*ReadWritePath `protobuf:"bytes,8,rep,name=read_write_path,json=readWritePath,proto3" json:"read_write_path,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ModelInfo is general information about a model plugin.
func (*ModelInfo) Descriptor ¶
func (*ModelInfo) GetGetStateMode ¶
func (*ModelInfo) GetModelData ¶
func (*ModelInfo) GetReadOnlyPath ¶
func (m *ModelInfo) GetReadOnlyPath() []*ReadOnlyPath
func (*ModelInfo) GetReadWritePath ¶
func (m *ModelInfo) GetReadWritePath() []*ReadWritePath
func (*ModelInfo) GetVersion ¶
func (*ModelInfo) ProtoMessage ¶
func (*ModelInfo) ProtoMessage()
func (*ModelInfo) XXX_DiscardUnknown ¶
func (m *ModelInfo) XXX_DiscardUnknown()
func (*ModelInfo) XXX_Marshal ¶
func (*ModelInfo) XXX_Unmarshal ¶
type ReadOnlyPath ¶
type ReadOnlyPath struct {
// path of the topmost `config false` object e.g. /cont1a/cont1b-state
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// ReadOnlySubPath is a set of children of the path including an entry for the
// type of the topmost object with subpath `/`
// An example is /list2b/index
SubPath []*ReadOnlySubPath `protobuf:"bytes,2,rep,name=sub_path,json=subPath,proto3" json:"sub_path,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ReadOnlyPath extracted from the model plugin as the definition of a tree of read only items. In YANG models items are defined as ReadOnly with the `config false` keyword. This can be applied to single items (leafs) or collections (containers or lists). When this `config false` is applied to an object every item beneath it will also become readonly - here these are shown as subpaths. The complete read only path then will be a concatenation of both e.g. /cont1a/cont1b-state/list2b/index and the type is defined in the SubPath as UInt8.
func (*ReadOnlyPath) Descriptor ¶
func (*ReadOnlyPath) Descriptor() ([]byte, []int)
func (*ReadOnlyPath) GetPath ¶
func (m *ReadOnlyPath) GetPath() string
func (*ReadOnlyPath) GetSubPath ¶
func (m *ReadOnlyPath) GetSubPath() []*ReadOnlySubPath
func (*ReadOnlyPath) ProtoMessage ¶
func (*ReadOnlyPath) ProtoMessage()
func (*ReadOnlyPath) Reset ¶
func (m *ReadOnlyPath) Reset()
func (*ReadOnlyPath) String ¶
func (m *ReadOnlyPath) String() string
func (*ReadOnlyPath) XXX_DiscardUnknown ¶
func (m *ReadOnlyPath) XXX_DiscardUnknown()
func (*ReadOnlyPath) XXX_Marshal ¶
func (m *ReadOnlyPath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadOnlyPath) XXX_Merge ¶
func (m *ReadOnlyPath) XXX_Merge(src proto.Message)
func (*ReadOnlyPath) XXX_Size ¶
func (m *ReadOnlyPath) XXX_Size() int
func (*ReadOnlyPath) XXX_Unmarshal ¶
func (m *ReadOnlyPath) XXX_Unmarshal(b []byte) error
type ReadOnlySubPath ¶
type ReadOnlySubPath struct {
// sub_path is the relative path of a child object e.g. /list2b/index
SubPath string `protobuf:"bytes,1,opt,name=sub_path,json=subPath,proto3" json:"sub_path,omitempty"`
// value_type is the datatype of the read only path
ValueType device.ValueType `` /* 130-byte string literal not displayed */
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ReadOnlySubPath is an extension to the ReadOnlyPath to define the datatype of the subpath
func (*ReadOnlySubPath) Descriptor ¶
func (*ReadOnlySubPath) Descriptor() ([]byte, []int)
func (*ReadOnlySubPath) GetSubPath ¶
func (m *ReadOnlySubPath) GetSubPath() string
func (*ReadOnlySubPath) GetValueType ¶
func (m *ReadOnlySubPath) GetValueType() device.ValueType
func (*ReadOnlySubPath) ProtoMessage ¶
func (*ReadOnlySubPath) ProtoMessage()
func (*ReadOnlySubPath) Reset ¶
func (m *ReadOnlySubPath) Reset()
func (*ReadOnlySubPath) String ¶
func (m *ReadOnlySubPath) String() string
func (*ReadOnlySubPath) XXX_DiscardUnknown ¶
func (m *ReadOnlySubPath) XXX_DiscardUnknown()
func (*ReadOnlySubPath) XXX_Marshal ¶
func (m *ReadOnlySubPath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadOnlySubPath) XXX_Merge ¶
func (m *ReadOnlySubPath) XXX_Merge(src proto.Message)
func (*ReadOnlySubPath) XXX_Size ¶
func (m *ReadOnlySubPath) XXX_Size() int
func (*ReadOnlySubPath) XXX_Unmarshal ¶
func (m *ReadOnlySubPath) XXX_Unmarshal(b []byte) error
type ReadWritePath ¶
type ReadWritePath struct {
// path is the full path to the attribute (leaf or leaf-list)
Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"`
// value_type is the data type of the attribute
ValueType device.ValueType `` /* 130-byte string literal not displayed */
// units is the unit of measurement e.g. dB, mV
Units string `protobuf:"bytes,3,opt,name=units,proto3" json:"units,omitempty"`
// description is an explaination of the meaning of the attribute
Description string `protobuf:"bytes,4,opt,name=description,proto3" json:"description,omitempty"`
// mandatory shows whether the attribute is optional (false) or required (true)
Mandatory bool `protobuf:"varint,5,opt,name=mandatory,proto3" json:"mandatory,omitempty"`
// default is a default value used with optional attributes
Default string `protobuf:"bytes,6,opt,name=default,proto3" json:"default,omitempty"`
// range is definition of the range of values a value is allowed
Range []string `protobuf:"bytes,7,rep,name=range,proto3" json:"range,omitempty"`
// length is a defintion of the length restrictions for the attribute
Length []string `protobuf:"bytes,8,rep,name=length,proto3" json:"length,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
ReadWritePath is extracted from the model plugin as the definition of a writeable attributes. In YANG models items are writable by default unless they are specified as `config false` or have an item with `config false` as a parent. Each configurable item has metadata with meanings taken from the YANG specification RFC 6020.
func (*ReadWritePath) Descriptor ¶
func (*ReadWritePath) Descriptor() ([]byte, []int)
func (*ReadWritePath) GetDefault ¶
func (m *ReadWritePath) GetDefault() string
func (*ReadWritePath) GetDescription ¶
func (m *ReadWritePath) GetDescription() string
func (*ReadWritePath) GetLength ¶
func (m *ReadWritePath) GetLength() []string
func (*ReadWritePath) GetMandatory ¶
func (m *ReadWritePath) GetMandatory() bool
func (*ReadWritePath) GetPath ¶
func (m *ReadWritePath) GetPath() string
func (*ReadWritePath) GetRange ¶
func (m *ReadWritePath) GetRange() []string
func (*ReadWritePath) GetUnits ¶
func (m *ReadWritePath) GetUnits() string
func (*ReadWritePath) GetValueType ¶
func (m *ReadWritePath) GetValueType() device.ValueType
func (*ReadWritePath) ProtoMessage ¶
func (*ReadWritePath) ProtoMessage()
func (*ReadWritePath) Reset ¶
func (m *ReadWritePath) Reset()
func (*ReadWritePath) String ¶
func (m *ReadWritePath) String() string
func (*ReadWritePath) XXX_DiscardUnknown ¶
func (m *ReadWritePath) XXX_DiscardUnknown()
func (*ReadWritePath) XXX_Marshal ¶
func (m *ReadWritePath) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*ReadWritePath) XXX_Merge ¶
func (m *ReadWritePath) XXX_Merge(src proto.Message)
func (*ReadWritePath) XXX_Size ¶
func (m *ReadWritePath) XXX_Size() int
func (*ReadWritePath) XXX_Unmarshal ¶
func (m *ReadWritePath) XXX_Unmarshal(b []byte) error
type RegisterResponse ¶
type RegisterResponse struct {
// name is name of the model plugin.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// version is the semantic version of the model plugin.
Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
RegisterResponse carries status of model plugin registration.
func (*RegisterResponse) Descriptor ¶
func (*RegisterResponse) Descriptor() ([]byte, []int)
func (*RegisterResponse) GetName ¶
func (m *RegisterResponse) GetName() string
func (*RegisterResponse) GetVersion ¶
func (m *RegisterResponse) GetVersion() string
func (*RegisterResponse) ProtoMessage ¶
func (*RegisterResponse) ProtoMessage()
func (*RegisterResponse) Reset ¶
func (m *RegisterResponse) Reset()
func (*RegisterResponse) String ¶
func (m *RegisterResponse) String() string
func (*RegisterResponse) XXX_DiscardUnknown ¶
func (m *RegisterResponse) XXX_DiscardUnknown()
func (*RegisterResponse) XXX_Marshal ¶
func (m *RegisterResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RegisterResponse) XXX_Merge ¶
func (m *RegisterResponse) XXX_Merge(src proto.Message)
func (*RegisterResponse) XXX_Size ¶
func (m *RegisterResponse) XXX_Size() int
func (*RegisterResponse) XXX_Unmarshal ¶
func (m *RegisterResponse) XXX_Unmarshal(b []byte) error
type RollbackRequest ¶
type RollbackRequest struct {
// name is an optional name of a Network Change to rollback.
// If no name is given the last network change will be rolled back.
// If the name given is not of the last network change and error will be given.
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// On optional comment to leave on the rollback.
Comment string `protobuf:"bytes,2,opt,name=comment,proto3" json:"comment,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
RollbackRequest carries the name of a network config to rollback. If there are subsequent changes to any of the devices in that config, the rollback will be rejected.
func (*RollbackRequest) Descriptor ¶
func (*RollbackRequest) Descriptor() ([]byte, []int)
func (*RollbackRequest) GetComment ¶
func (m *RollbackRequest) GetComment() string
func (*RollbackRequest) GetName ¶
func (m *RollbackRequest) GetName() string
func (*RollbackRequest) ProtoMessage ¶
func (*RollbackRequest) ProtoMessage()
func (*RollbackRequest) Reset ¶
func (m *RollbackRequest) Reset()
func (*RollbackRequest) String ¶
func (m *RollbackRequest) String() string
func (*RollbackRequest) XXX_DiscardUnknown ¶
func (m *RollbackRequest) XXX_DiscardUnknown()
func (*RollbackRequest) XXX_Marshal ¶
func (m *RollbackRequest) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RollbackRequest) XXX_Merge ¶
func (m *RollbackRequest) XXX_Merge(src proto.Message)
func (*RollbackRequest) XXX_Size ¶
func (m *RollbackRequest) XXX_Size() int
func (*RollbackRequest) XXX_Unmarshal ¶
func (m *RollbackRequest) XXX_Unmarshal(b []byte) error
type RollbackResponse ¶
type RollbackResponse struct {
// A message showing the result of the rollback.
Message string `protobuf:"bytes,1,opt,name=message,proto3" json:"message,omitempty"`
XXX_NoUnkeyedLiteral struct{} `json:"-"`
XXX_unrecognized []byte `json:"-"`
XXX_sizecache int32 `json:"-"`
}
RollbackResponse carries the response of the rollback operation
func (*RollbackResponse) Descriptor ¶
func (*RollbackResponse) Descriptor() ([]byte, []int)
func (*RollbackResponse) GetMessage ¶
func (m *RollbackResponse) GetMessage() string
func (*RollbackResponse) ProtoMessage ¶
func (*RollbackResponse) ProtoMessage()
func (*RollbackResponse) Reset ¶
func (m *RollbackResponse) Reset()
func (*RollbackResponse) String ¶
func (m *RollbackResponse) String() string
func (*RollbackResponse) XXX_DiscardUnknown ¶
func (m *RollbackResponse) XXX_DiscardUnknown()
func (*RollbackResponse) XXX_Marshal ¶
func (m *RollbackResponse) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
func (*RollbackResponse) XXX_Merge ¶
func (m *RollbackResponse) XXX_Merge(src proto.Message)
func (*RollbackResponse) XXX_Size ¶
func (m *RollbackResponse) XXX_Size() int
func (*RollbackResponse) XXX_Unmarshal ¶
func (m *RollbackResponse) XXX_Unmarshal(b []byte) error
type Type ¶
type Type int32
Streaming event type
const ( // NONE indicates this response does not represent a state change Type_NONE Type = 0 // ADDED is an event which occurs when an item is added Type_ADDED Type = 1 // UPDATED is an event which occurs when an item is updated Type_UPDATED Type = 2 // REMOVED is an event which occurs when an item is removed Type_REMOVED Type = 3 )
func (Type) EnumDescriptor ¶
type UnimplementedConfigAdminServiceServer ¶
type UnimplementedConfigAdminServiceServer struct {
}
UnimplementedConfigAdminServiceServer can be embedded to have forward compatible implementations.
func (*UnimplementedConfigAdminServiceServer) CompactChanges ¶
func (*UnimplementedConfigAdminServiceServer) CompactChanges(ctx context.Context, req *CompactChangesRequest) (*CompactChangesResponse, error)
func (*UnimplementedConfigAdminServiceServer) ListRegisteredModels ¶
func (*UnimplementedConfigAdminServiceServer) ListRegisteredModels(req *ListModelsRequest, srv ConfigAdminService_ListRegisteredModelsServer) error
func (*UnimplementedConfigAdminServiceServer) ListSnapshots ¶
func (*UnimplementedConfigAdminServiceServer) ListSnapshots(req *ListSnapshotsRequest, srv ConfigAdminService_ListSnapshotsServer) error
func (*UnimplementedConfigAdminServiceServer) RollbackNetworkChange ¶
func (*UnimplementedConfigAdminServiceServer) RollbackNetworkChange(ctx context.Context, req *RollbackRequest) (*RollbackResponse, error)
func (*UnimplementedConfigAdminServiceServer) UploadRegisterModel ¶
func (*UnimplementedConfigAdminServiceServer) UploadRegisterModel(srv ConfigAdminService_UploadRegisterModelServer) error