v1

Documentation

Overview

Package v1 implements the version v1 client for communicating with CloudVision.

Index

• func NewV1Client(gc gnmi.GNMIClient, deviceID string, isMgmtSystem bool) cvclient.CVClient
• type Metadata
  • func NewMetadataFromIncoming(ctx context.Context) (Metadata, error)
  • func NewMetadataFromOutgoing(ctx context.Context) (Metadata, error)

Functions

func NewV1Client

func NewV1Client(gc gnmi.GNMIClient, deviceID string, isMgmtSystem bool) cvclient.CVClient

NewV1Client returns a new v1client object.

Types

type Metadata

type Metadata struct {
	DeviceID string
	// TypeCheck indicates whether the gNMI server should perform OpenConfig type-checking.
	TypeCheck bool
	// OpenConfig indicates whether transmitted gNMI data is OpenConfig-modeled.
	OpenConfig       bool
	DeviceType       *string
	Alive            *bool
	CollectorVersion string
}

Metadata represents all grpc metadata about a device.

func NewMetadataFromIncoming

func NewMetadataFromIncoming(ctx context.Context) (Metadata, error)

NewMetadataFromIncoming returns a metadata from an incoming context.

func NewMetadataFromOutgoing

func NewMetadataFromOutgoing(ctx context.Context) (Metadata, error)

NewMetadataFromOutgoing returns a metadata from an outgoing context.