linkqual

type AsicLoopbackCapabilities struct {

	// The minimum time required to set up the ASIC loopback mode.
	MinSetupDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=min_setup_duration,json=minSetupDuration,proto3" json:"min_setup_duration,omitempty"`
	// The minimum time required to return the interfaces to their pre-test state
	// following a qualification.
	MinTeardownDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=min_teardown_duration,json=minTeardownDuration,proto3" json:"min_teardown_duration,omitempty"`
	Fields              []HeaderMatchField   `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

type AsicLoopbackConfiguration struct {
	// contains filtered or unexported fields
}

type CapabilitiesRequest struct {
	// contains filtered or unexported fields
}

type CapabilitiesResponse struct {

	// Current timestamp on the service.
	Time *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=time,proto3" json:"time,omitempty"`
	// Indicates that the device's time is currently synchronised via NTP.
	NtpSynced bool `protobuf:"varint,2,opt,name=ntp_synced,json=ntpSynced,proto3" json:"ntp_synced,omitempty"`
	// Capabilities that the generator and reflect support on the
	// service. If the top level field is unset the service cannot act
	// as any defined generator or reflector.
	Generator *GeneratorCapabilities `protobuf:"bytes,3,opt,name=generator,proto3" json:"generator,omitempty"`
	Reflector *ReflectorCapabilities `protobuf:"bytes,4,opt,name=reflector,proto3" json:"reflector,omitempty"`
	// Maximum number of results allowed to be stored per interface.
	// The minimum supported just be 2 or greater.
	MaxHistoricalResultsPerInterface uint64 `` /* 164-byte string literal not displayed */
	// contains filtered or unexported fields
}

type CreateRequest struct {
	Interfaces []*QualificationConfiguration `protobuf:"bytes,1,rep,name=interfaces,proto3" json:"interfaces,omitempty"`
	// contains filtered or unexported fields
}

type CreateResponse struct {
	Status map[string]*status.Status `` /* 153-byte string literal not displayed */
	// contains filtered or unexported fields
}

type DeleteRequest struct {
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

type DeleteResponse struct {
	Results map[string]*status.Status `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

type GeneratorCapabilities struct {
	PacketGenerator *PacketGeneratorCapabilities `protobuf:"bytes,1,opt,name=packet_generator,json=packetGenerator,proto3" json:"packet_generator,omitempty"`
	PacketInjector  *PacketInjectorCapabilities  `protobuf:"bytes,2,opt,name=packet_injector,json=packetInjector,proto3" json:"packet_injector,omitempty"`
	// contains filtered or unexported fields
}

type GetRequest struct {
	Ids []string `protobuf:"bytes,1,rep,name=ids,proto3" json:"ids,omitempty"`
	// contains filtered or unexported fields
}

type GetResponse struct {
	Results map[string]*QualificationResult `` /* 155-byte string literal not displayed */
	// contains filtered or unexported fields
}

type HeaderMatchField int32

type LinkQualificationClient interface {
	// Create will dispatch a create operation for each interface and return.
	// The rpc will only return an error in the case that gNOI service cannot
	// handle the RPC request. Create will return an error on failure to
	// create the qualification.
	Create(ctx context.Context, in *CreateRequest, opts ...grpc.CallOption) (*CreateResponse, error)
	// Get will return the status for the provided qualification ids.
	Get(ctx context.Context, in *GetRequest, opts ...grpc.CallOption) (*GetResponse, error)
	// Capabilities will return the capabilities of the gnoi.LinkQualification
	// service implementation.  This RPC is used to allow the caller to
	// orchestrate the peer requirements of the service to complete a link
	// qualification between two devices.
	Capabilities(ctx context.Context, in *CapabilitiesRequest, opts ...grpc.CallOption) (*CapabilitiesResponse, error)
	// Delete will remove the qualification results for the provided ids.
	// If the qualification is not in QUALIFICATION_STATE_COMPLETED
	// or QUALIFICATION_STATE_ERROR, the qualification will be canceled then
	// deleted as requested.
	// If the qualification cannot be stopped or deleted a status will be returned
	// with the error.
	// If the id is not found NOT_FOUND will be returned.
	Delete(ctx context.Context, in *DeleteRequest, opts ...grpc.CallOption) (*DeleteResponse, error)
	// List qualifications currently on the target.
	List(ctx context.Context, in *ListRequest, opts ...grpc.CallOption) (*ListResponse, error)
}

type LinkQualificationServer interface {
	// Create will dispatch a create operation for each interface and return.
	// The rpc will only return an error in the case that gNOI service cannot
	// handle the RPC request. Create will return an error on failure to
	// create the qualification.
	Create(context.Context, *CreateRequest) (*CreateResponse, error)
	// Get will return the status for the provided qualification ids.
	Get(context.Context, *GetRequest) (*GetResponse, error)
	// Capabilities will return the capabilities of the gnoi.LinkQualification
	// service implementation.  This RPC is used to allow the caller to
	// orchestrate the peer requirements of the service to complete a link
	// qualification between two devices.
	Capabilities(context.Context, *CapabilitiesRequest) (*CapabilitiesResponse, error)
	// Delete will remove the qualification results for the provided ids.
	// If the qualification is not in QUALIFICATION_STATE_COMPLETED
	// or QUALIFICATION_STATE_ERROR, the qualification will be canceled then
	// deleted as requested.
	// If the qualification cannot be stopped or deleted a status will be returned
	// with the error.
	// If the id is not found NOT_FOUND will be returned.
	Delete(context.Context, *DeleteRequest) (*DeleteResponse, error)
	// List qualifications currently on the target.
	List(context.Context, *ListRequest) (*ListResponse, error)
	// contains filtered or unexported methods
}

type ListRequest struct {
	// contains filtered or unexported fields
}

type ListResponse struct {

	// The results that have not yet been deleted from the device.
	Results []*ListResult `protobuf:"bytes,1,rep,name=results,proto3" json:"results,omitempty"`
	// contains filtered or unexported fields
}

type ListResult struct {
	Id            string             `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	State         QualificationState `protobuf:"varint,2,opt,name=state,proto3,enum=gnoi.packet_link_qualification.QualificationState" json:"state,omitempty"`
	InterfaceName string             `protobuf:"bytes,3,opt,name=interface_name,json=interfaceName,proto3" json:"interface_name,omitempty"`
	// contains filtered or unexported fields
}

type NTPSyncedTiming struct {

	// The timestamp for the start of the qualification. Based on the
	// provided configuration the qualification setup must
	// at least start at (start_time - min_setup_time).
	StartTime *timestamppb.Timestamp `protobuf:"bytes,1,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The timestamp for the end of qualification.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,2,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Timestamp to begin teardown. If unset teardown will start
	// immediately after end_time.
	// This value allows for a peer to wait for before tearing down
	// the port under test.
	// teardown_time must occur after end_time.
	TeardownTime *timestamppb.Timestamp `protobuf:"bytes,3,opt,name=teardown_time,json=teardownTime,proto3" json:"teardown_time,omitempty"`
	// contains filtered or unexported fields
}

type PacketGeneratorCapabilities struct {
	MaxBps uint64 `protobuf:"varint,1,opt,name=max_bps,json=maxBps,proto3" json:"max_bps,omitempty"` // bits per second
	MaxPps uint64 `protobuf:"varint,2,opt,name=max_pps,json=maxPps,proto3" json:"max_pps,omitempty"` // packets per second
	MinMtu uint32 `protobuf:"varint,3,opt,name=min_mtu,json=minMtu,proto3" json:"min_mtu,omitempty"` // minimum MTU supported.
	MaxMtu uint32 `protobuf:"varint,4,opt,name=max_mtu,json=maxMtu,proto3" json:"max_mtu,omitempty"` // max MTU supported.
	// The minimum duration required to set up a packet generator-based
	// qualification.
	MinSetupDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=min_setup_duration,json=minSetupDuration,proto3" json:"min_setup_duration,omitempty"`
	// The minimum time required to return the affected interface to the
	// pre-test state.
	MinTeardownDuration *durationpb.Duration `protobuf:"bytes,6,opt,name=min_teardown_duration,json=minTeardownDuration,proto3" json:"min_teardown_duration,omitempty"`
	// The minimum interval between samples for statistics relating to the
	// qualification.
	MinSampleInterval *durationpb.Duration `protobuf:"bytes,7,opt,name=min_sample_interval,json=minSampleInterval,proto3" json:"min_sample_interval,omitempty"`
	// contains filtered or unexported fields
}

type PacketGeneratorConfiguration struct {

	// Packet per second rate to use for this test.
	PacketRate uint64 `protobuf:"varint,1,opt,name=packet_rate,json=packetRate,proto3" json:"packet_rate,omitempty"`
	// Size of packets to inject.
	// if unspecified, the default value is 1500 bytes.
	PacketSize uint32 `protobuf:"varint,2,opt,name=packet_size,json=packetSize,proto3" json:"packet_size,omitempty"`
	// contains filtered or unexported fields
}

type PacketInjectorCapabilities struct {

	// The definitions of fields 1-7 are the same as those described in the
	// PacketGeneratorCapabilities message.
	MinMtu              uint32               `protobuf:"varint,1,opt,name=min_mtu,json=minMtu,proto3" json:"min_mtu,omitempty"`
	MaxMtu              uint32               `protobuf:"varint,2,opt,name=max_mtu,json=maxMtu,proto3" json:"max_mtu,omitempty"`
	MinInjectedPackets  uint32               `protobuf:"varint,3,opt,name=min_injected_packets,json=minInjectedPackets,proto3" json:"min_injected_packets,omitempty"`
	MaxInjectedPackets  uint32               `protobuf:"varint,4,opt,name=max_injected_packets,json=maxInjectedPackets,proto3" json:"max_injected_packets,omitempty"`
	MinSetupDuration    *durationpb.Duration `protobuf:"bytes,5,opt,name=min_setup_duration,json=minSetupDuration,proto3" json:"min_setup_duration,omitempty"`
	MinTeardownDuration *durationpb.Duration `protobuf:"bytes,6,opt,name=min_teardown_duration,json=minTeardownDuration,proto3" json:"min_teardown_duration,omitempty"`
	MinSampleInterval   *durationpb.Duration `protobuf:"bytes,7,opt,name=min_sample_interval,json=minSampleInterval,proto3" json:"min_sample_interval,omitempty"`
	// Loopback modes that are supported by the device when using the packet
	// injector mode.
	LoopbackModes []PacketInjectorLoopbackMode `` /* 171-byte string literal not displayed */
	// contains filtered or unexported fields
}

type PacketInjectorConfiguration struct {

	// Number of packets to inject into the closed loop.
	PacketCount uint32 `protobuf:"varint,1,opt,name=packet_count,json=packetCount,proto3" json:"packet_count,omitempty"`
	// Size of packets to inject.
	// if unspecified, the default value is 1500 bytes.
	PacketSize uint32 `protobuf:"varint,2,opt,name=packet_size,json=packetSize,proto3" json:"packet_size,omitempty"`
	// Loopback mode for this qualification.
	//
	// Types that are assignable to LoopbackMode:
	//
	//	*PacketInjectorConfiguration_PmdLoopback
	//	*PacketInjectorConfiguration_AsicLoopback
	LoopbackMode isPacketInjectorConfiguration_LoopbackMode `protobuf_oneof:"loopback_mode"`
	// contains filtered or unexported fields
}

type PacketInjectorConfiguration_AsicLoopback struct {
	// ASIC based loops are done inside the forwarding
	// engine and must have stats available to the
	// qualification.
	AsicLoopback *AsicLoopbackConfiguration `protobuf:"bytes,102,opt,name=asic_loopback,json=asicLoopback,proto3,oneof"`
}

type PacketInjectorConfiguration_PmdLoopback struct {
	// PMD based loopback encompasses either PHY based port
	// loopbacks or port based ASIC loopbacks which do
	// use forwarding engine processing.
	// Their use may limit the stats available for the
	// qualification.
	PmdLoopback *PmdLoopbackConfiguration `protobuf:"bytes,101,opt,name=pmd_loopback,json=pmdLoopback,proto3,oneof"`
}

type PacketInjectorLoopbackMode int32

type PmdLoopbackCapabilities struct {
	MinSetupDuration    *durationpb.Duration `protobuf:"bytes,1,opt,name=min_setup_duration,json=minSetupDuration,proto3" json:"min_setup_duration,omitempty"`
	MinTeardownDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=min_teardown_duration,json=minTeardownDuration,proto3" json:"min_teardown_duration,omitempty"`
	// contains filtered or unexported fields
}

type PmdLoopbackConfiguration struct {
	// contains filtered or unexported fields
}

type QualificationConfiguration struct {

	// Id to be used for this interface qualification run.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// interface name on the device must be unique to the device.
	InterfaceName string `protobuf:"bytes,2,opt,name=interface_name,json=interfaceName,proto3" json:"interface_name,omitempty"`
	// timing allows for specifying either NTP or by using the Create RPC as
	// the synchronization method for the qualification.
	//
	// Types that are assignable to Timing:
	//
	//	*QualificationConfiguration_Ntp
	//	*QualificationConfiguration_Rpc
	Timing isQualificationConfiguration_Timing `protobuf_oneof:"timing"`
	// endpoint_type is how this side of the link will be configured for the
	// qualification.
	//
	// Types that are assignable to EndpointType:
	//
	//	*QualificationConfiguration_PacketGenerator
	//	*QualificationConfiguration_PacketInjector
	//	*QualificationConfiguration_PmdLoopback
	//	*QualificationConfiguration_AsicLoopback
	EndpointType isQualificationConfiguration_EndpointType `protobuf_oneof:"endpoint_type"`
	// contains filtered or unexported fields
}

type QualificationConfiguration_AsicLoopback struct {
	AsicLoopback *AsicLoopbackConfiguration `protobuf:"bytes,114,opt,name=asic_loopback,json=asicLoopback,proto3,oneof"`
}

type QualificationConfiguration_Ntp struct {
	Ntp *NTPSyncedTiming `protobuf:"bytes,101,opt,name=ntp,proto3,oneof"`
}

type QualificationConfiguration_PacketGenerator struct {
	PacketGenerator *PacketGeneratorConfiguration `protobuf:"bytes,111,opt,name=packet_generator,json=packetGenerator,proto3,oneof"`
}

type QualificationConfiguration_PacketInjector struct {
	PacketInjector *PacketInjectorConfiguration `protobuf:"bytes,112,opt,name=packet_injector,json=packetInjector,proto3,oneof"`
}

type QualificationConfiguration_PmdLoopback struct {
	PmdLoopback *PmdLoopbackConfiguration `protobuf:"bytes,113,opt,name=pmd_loopback,json=pmdLoopback,proto3,oneof"`
}

type QualificationConfiguration_Rpc struct {
	Rpc *RPCSyncedTiming `protobuf:"bytes,102,opt,name=rpc,proto3,oneof"`
}

type QualificationResult struct {

	// ID of the qualification.
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// Interface name of the qualification.
	InterfaceName string `protobuf:"bytes,2,opt,name=interface_name,json=interfaceName,proto3" json:"interface_name,omitempty"`
	// The state the test was in when the results were snapshotted.
	State QualificationState `protobuf:"varint,3,opt,name=state,proto3,enum=gnoi.packet_link_qualification.QualificationState" json:"state,omitempty"`
	// The number of qualification packets sent.
	PacketsSent uint64 `protobuf:"varint,4,opt,name=packets_sent,json=packetsSent,proto3" json:"packets_sent,omitempty"`
	// The number of qualification packets received.
	PacketsReceived uint64 `protobuf:"varint,5,opt,name=packets_received,json=packetsReceived,proto3" json:"packets_received,omitempty"`
	// The number of packets transmitted that experienced corruption.
	PacketsError uint64 `protobuf:"varint,6,opt,name=packets_error,json=packetsError,proto3" json:"packets_error,omitempty"`
	// The number of packets dropped by the device due to internal drop,
	// lookup or forwarding errors.
	PacketsDropped uint64 `protobuf:"varint,7,opt,name=packets_dropped,json=packetsDropped,proto3" json:"packets_dropped,omitempty"`
	// The qualification start time. Also when the first snapshot of
	// results are taken.
	StartTime *timestamppb.Timestamp `protobuf:"bytes,8,opt,name=start_time,json=startTime,proto3" json:"start_time,omitempty"`
	// The qualification end time or the current snapshot time since epoch.
	EndTime *timestamppb.Timestamp `protobuf:"bytes,9,opt,name=end_time,json=endTime,proto3" json:"end_time,omitempty"`
	// Expected rate for the qualification. This is the computed or
	// observed rate that the service expected to be maintained
	// throughout the qualification duration.
	ExpectedRateBytesPerSecond uint64 `` /* 147-byte string literal not displayed */
	// The qualification rate observed during the qualification.
	// It is updated every min_sample_interval in bytes per second.
	QualificationRateBytesPerSecond uint64 `` /* 162-byte string literal not displayed */
	// Status response for the Qualification result. Will only be set if the
	// state is QUALIFICATION_STATE_ERROR.
	Status *status.Status `protobuf:"bytes,12,opt,name=status,proto3" json:"status,omitempty"`
	// contains filtered or unexported fields
}

type QualificationState int32

type RPCSyncedTiming struct {

	// pre_sync_duration is the time the service should wait before starting
	// setup.
	// For generators this would be the time the remote side needs to put itself
	// into loopback before generating packets.
	// For loopbacks this value would be expected to be zero or unset.
	PreSyncDuration *durationpb.Duration `protobuf:"bytes,1,opt,name=pre_sync_duration,json=preSyncDuration,proto3" json:"pre_sync_duration,omitempty"`
	// The requested setup time for the endpoint. setup_duration must be >=
	// min_setup_duration in the service capabilities. If the service
	// completes setup before setup_duration it must wait setup_duration
	// before moving to qualification.
	SetupDuration *durationpb.Duration `protobuf:"bytes,2,opt,name=setup_duration,json=setupDuration,proto3" json:"setup_duration,omitempty"`
	// duration is the length of the qualification.
	Duration *durationpb.Duration `protobuf:"bytes,3,opt,name=duration,proto3" json:"duration,omitempty"`
	// post_sync_duration is the amount time a side should wait before starting
	// its teardown.
	// For generators this value would be expected to be zero or unset.
	// For loopbacks this would be the duration it takes for the generator
	// to stop sending packets before starting a teardown.
	PostSyncDuration *durationpb.Duration `protobuf:"bytes,4,opt,name=post_sync_duration,json=postSyncDuration,proto3" json:"post_sync_duration,omitempty"`
	// This requested teardown duration for the endpoint. teardown_duration
	// must be >= min_teardown_duration in the service capabilities. If the
	// service completes before the teardown_duration it must wait teardown
	// duration before completing.
	TeardownDuration *durationpb.Duration `protobuf:"bytes,5,opt,name=teardown_duration,json=teardownDuration,proto3" json:"teardown_duration,omitempty"`
	// contains filtered or unexported fields
}

type ReflectorCapabilities struct {
	PmdLoopback  *PmdLoopbackCapabilities  `protobuf:"bytes,1,opt,name=pmd_loopback,json=pmdLoopback,proto3" json:"pmd_loopback,omitempty"`
	AsicLoopback *AsicLoopbackCapabilities `protobuf:"bytes,2,opt,name=asic_loopback,json=asicLoopback,proto3" json:"asic_loopback,omitempty"`
	// contains filtered or unexported fields
}

type UnimplementedLinkQualificationServer struct {
}

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