Documentation
¶
Index ¶
- Variables
- type Configuration
- func (*Configuration) Descriptor() ([]byte, []int)deprecated
- func (x *Configuration) GetInstanceId() string
- func (x *Configuration) GetMeta() map[string]string
- func (x *Configuration) GetRequest() map[string]*gnmi.SubscribeRequest
- func (x *Configuration) GetRevision() int64
- func (x *Configuration) GetTarget() map[string]*Target
- func (*Configuration) ProtoMessage()
- func (x *Configuration) ProtoReflect() protoreflect.Message
- func (x *Configuration) Reset()
- func (x *Configuration) String() string
- type Credentials
- func (*Credentials) Descriptor() ([]byte, []int)deprecated
- func (x *Credentials) GetPassword() string
- func (x *Credentials) GetPasswordId() string
- func (x *Credentials) GetUsername() string
- func (*Credentials) ProtoMessage()
- func (x *Credentials) ProtoReflect() protoreflect.Message
- func (x *Credentials) Reset()
- func (x *Credentials) String() string
- type Target
- func (*Target) Descriptor() ([]byte, []int)deprecated
- func (x *Target) GetAddresses() []string
- func (x *Target) GetCredentials() *Credentials
- func (x *Target) GetDialer() string
- func (x *Target) GetMeta() map[string]string
- func (x *Target) GetRequest() string
- func (*Target) ProtoMessage()
- func (x *Target) ProtoReflect() protoreflect.Message
- func (x *Target) Reset()
- func (x *Target) String() string
Constants ¶
This section is empty.
Variables ¶
View Source
var File_proto_target_target_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type Configuration ¶
type Configuration struct {
// Request is a keyed list of all SubscriptionRequests that can be sent
// to targets in the Configuration.
// The request must have at minimum a SubscriptionList with a prefix
// containing origin and one or more Subscriptions. Only the STREAM mode is
// supported.
Request map[string]*gnmi.SubscribeRequest `` /* 155-byte string literal not displayed */
// Target is the full list of targets connected to by a caching gNMI
// collector. The key of the map is a unique name to identify a target and
// is set in the prefix.target of a SubscriptionRequest message when
// connecting to each respective target.
Target map[string]*Target `` /* 153-byte string literal not displayed */
// Identifier for the caching collector.
InstanceId string `protobuf:"bytes,3,opt,name=instance_id,json=instanceId,proto3" json:"instance_id,omitempty"`
// Additional config metadata.
Meta map[string]string `` /* 149-byte string literal not displayed */
// Revision for this Configuration. Systems that non-atomically write
// configuration should populate and require revision, leveraging canonical
// protobuf serialization of fields in order. Presence of this field makes no
// guarantee. Consumers should account for atomicity constraints of their
// environment and any custom encoding.
Revision int64 `protobuf:"varint,536870911,opt,name=revision,proto3" json:"revision,omitempty"`
// contains filtered or unexported fields
}
Configuration holds all information necessary for a caching gNMI collector to establish subscriptions to a list of gNMI targets.
func (*Configuration) Descriptor
deprecated
func (*Configuration) Descriptor() ([]byte, []int)
Deprecated: Use Configuration.ProtoReflect.Descriptor instead.
func (*Configuration) GetInstanceId ¶
func (x *Configuration) GetInstanceId() string
func (*Configuration) GetMeta ¶
func (x *Configuration) GetMeta() map[string]string
func (*Configuration) GetRequest ¶
func (x *Configuration) GetRequest() map[string]*gnmi.SubscribeRequest
func (*Configuration) GetRevision ¶
func (x *Configuration) GetRevision() int64
func (*Configuration) GetTarget ¶
func (x *Configuration) GetTarget() map[string]*Target
func (*Configuration) ProtoMessage ¶
func (*Configuration) ProtoMessage()
func (*Configuration) ProtoReflect ¶
func (x *Configuration) ProtoReflect() protoreflect.Message
func (*Configuration) Reset ¶
func (x *Configuration) Reset()
func (*Configuration) String ¶
func (x *Configuration) String() string
type Credentials ¶
type Credentials struct {
Username string `protobuf:"bytes,1,opt,name=username,proto3" json:"username,omitempty"`
Password string `protobuf:"bytes,2,opt,name=password,proto3" json:"password,omitempty"`
// Password lookup ID.
PasswordId string `protobuf:"bytes,3,opt,name=password_id,json=passwordId,proto3" json:"password_id,omitempty"`
// contains filtered or unexported fields
}
Credentials contains the fields necessary for authentication of the client to the target.
func (*Credentials) Descriptor
deprecated
func (*Credentials) Descriptor() ([]byte, []int)
Deprecated: Use Credentials.ProtoReflect.Descriptor instead.
func (*Credentials) GetPassword ¶
func (x *Credentials) GetPassword() string
func (*Credentials) GetPasswordId ¶
func (x *Credentials) GetPasswordId() string
func (*Credentials) GetUsername ¶
func (x *Credentials) GetUsername() string
func (*Credentials) ProtoMessage ¶
func (*Credentials) ProtoMessage()
func (*Credentials) ProtoReflect ¶
func (x *Credentials) ProtoReflect() protoreflect.Message
func (*Credentials) Reset ¶
func (x *Credentials) Reset()
func (*Credentials) String ¶
func (x *Credentials) String() string
type Target ¶
type Target struct {
// A list of address and port or name that resolves to an address and port.
Addresses []string `protobuf:"bytes,1,rep,name=addresses,proto3" json:"addresses,omitempty"`
// Credentials to use in metadata for authorization of the RPC
Credentials *Credentials `protobuf:"bytes,2,opt,name=credentials,proto3" json:"credentials,omitempty"`
// The request to be sent to the target. The string supplied is looked up in
// the request map of the Configuration message.
Request string `protobuf:"bytes,3,opt,name=request,proto3" json:"request,omitempty"`
// Additional target metadata.
Meta map[string]string `` /* 149-byte string literal not displayed */
// How should the target be dialed. This option allows for a custom
// implementation for how this target is to be reached. If unset the
// collector's default implementation will be used.
Dialer string `protobuf:"bytes,5,opt,name=dialer,proto3" json:"dialer,omitempty"`
// contains filtered or unexported fields
}
Target is the information necessary to establish a single gNMI Subscribe RPC to be collected and cached.
func (*Target) Descriptor
deprecated
func (*Target) GetAddresses ¶
func (*Target) GetCredentials ¶
func (x *Target) GetCredentials() *Credentials
func (*Target) GetRequest ¶
func (*Target) ProtoMessage ¶
func (*Target) ProtoMessage()
func (*Target) ProtoReflect ¶
func (x *Target) ProtoReflect() protoreflect.Message
Click to show internal directories.
Click to hide internal directories.