interfaces

Documentation

Overview

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

This file is autogenerated. Do not modify

Index

• type CapabilitiesController
• type CapabilitiesHandler
• type CaptureController
• type CaptureHandler
• type ConfigurationController
• type ConfigurationHandler
• type ControlController
• type ControlHandler
• type MetricsController
• type MetricsHandler
• type MonitorController
• type MonitorHandler
• type StatesController
• type StatesHandler

Types

type CapabilitiesController

type CapabilitiesController interface {
	Routes() []httpapi.Route
	GetVersion(w http.ResponseWriter, r *http.Request)
}

type CapabilitiesHandler

type CapabilitiesHandler interface {
	GetController() CapabilitiesController
	/*
		GetVersion: GET /capabilities/version
		Description:
	*/
	GetVersion(r *http.Request) (gosnappi.GetVersionResponse, error)
}

type CaptureController

type CaptureController interface {
	Routes() []httpapi.Route
	GetCapture(w http.ResponseWriter, r *http.Request)
}

type CaptureHandler

type CaptureHandler interface {
	GetController() CaptureController
	/*
		GetCapture: POST /results/capture
		Description:
	*/
	GetCapture(rbody gosnappi.CaptureRequest, r *http.Request) gosnappi.GetCaptureResponse
}

type ConfigurationController

type ConfigurationController interface {
	Routes() []httpapi.Route
	SetConfig(w http.ResponseWriter, r *http.Request)
	GetConfig(w http.ResponseWriter, r *http.Request)
	UpdateConfig(w http.ResponseWriter, r *http.Request)
}

type ConfigurationHandler

type ConfigurationHandler interface {
	GetController() ConfigurationController
	/*
		SetConfig: POST /config
		Description: Sets configuration resources on the traffic generator.
	*/
	SetConfig(rbody gosnappi.Config, r *http.Request) (gosnappi.SetConfigResponse, error)
	/*
		GetConfig: GET /config
		Description:
	*/
	GetConfig(r *http.Request) (gosnappi.GetConfigResponse, error)
	/*
			UpdateConfig: PATCH /config
			Description: Updates specific attributes of resources configured on the traffic generator. The fetched configuration shall reflect the updates applied successfully.
		The Response.Warnings in the Success response is available for implementers to disclose additional information about a state change including any implicit changes that are outside the scope of the state change.
	*/
	UpdateConfig(rbody gosnappi.ConfigUpdate, r *http.Request) (gosnappi.UpdateConfigResponse, error)
}

type ControlController

type ControlController interface {
	Routes() []httpapi.Route
	SetControlState(w http.ResponseWriter, r *http.Request)
	SetControlAction(w http.ResponseWriter, r *http.Request)
}

type ControlHandler

type ControlHandler interface {
	GetController() ControlController
	/*
		SetControlState: POST /control/state
		Description: Sets the operational state of configured resources.
	*/
	SetControlState(rbody gosnappi.ControlState, r *http.Request) (gosnappi.SetControlStateResponse, error)
	/*
		SetControlAction: POST /control/action
		Description: Triggers actions against configured resources.
	*/
	SetControlAction(rbody gosnappi.ControlAction, r *http.Request) (gosnappi.SetControlActionResponse, error)
}

type MetricsController

type MetricsController interface {
	Routes() []httpapi.Route
	GetMetrics(w http.ResponseWriter, r *http.Request)
}

type MetricsHandler

type MetricsHandler interface {
	GetController() MetricsController
	/*
		GetMetrics: POST /results/metrics
		Description:
	*/
	GetMetrics(rbody gosnappi.MetricsRequest, r *http.Request) gosnappi.GetMetricsResponse
}

type MonitorController

type MonitorController interface {
	Routes() []httpapi.Route
	GetMetrics(w http.ResponseWriter, r *http.Request)
	GetStates(w http.ResponseWriter, r *http.Request)
	GetCapture(w http.ResponseWriter, r *http.Request)
}

type MonitorHandler

type MonitorHandler interface {
	GetController() MonitorController
	/*
		GetMetrics: POST /monitor/metrics
		Description:
	*/
	GetMetrics(rbody gosnappi.MetricsRequest, r *http.Request) (gosnappi.GetMetricsResponse, error)
	/*
		GetStates: POST /monitor/states
		Description:
	*/
	GetStates(rbody gosnappi.StatesRequest, r *http.Request) (gosnappi.GetStatesResponse, error)
	/*
		GetCapture: POST /monitor/capture
		Description:
	*/
	GetCapture(rbody gosnappi.CaptureRequest, r *http.Request) (gosnappi.GetCaptureResponse, error)
}

type StatesController

type StatesController interface {
	Routes() []httpapi.Route
	GetStates(w http.ResponseWriter, r *http.Request)
}

type StatesHandler

type StatesHandler interface {
	GetController() StatesController
	/*
		GetStates: POST /results/states
		Description:
	*/
	GetStates(rbody gosnappi.StatesRequest, r *http.Request) gosnappi.GetStatesResponse
}