v1

package
v0.1.401 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Mar 10, 2025 License: Apache-2.0 Imports: 17 Imported by: 4

Documentation

Overview

Package v1 is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source 
var (
	PackageFormat_name = map[int32]string{
		0: "PACKAGE_FORMAT_UNSPECIFIED",
		1: "PACKAGE_FORMAT_RAW",
		2: "PACKAGE_FORMAT_XZ",
		3: "PACKAGE_FORMAT_EXECUTABLE",
		4: "PACKAGE_FORMAT_XZ_EXECUTABLE",
	}
	PackageFormat_value = map[string]int32{
		"PACKAGE_FORMAT_UNSPECIFIED":   0,
		"PACKAGE_FORMAT_RAW":           1,
		"PACKAGE_FORMAT_XZ":            2,
		"PACKAGE_FORMAT_EXECUTABLE":    3,
		"PACKAGE_FORMAT_XZ_EXECUTABLE": 4,
	}
)

Enum value maps for PackageFormat.

View Source 
var AgentDeviceService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "viam.app.agent.v1.AgentDeviceService",
	HandlerType: (*AgentDeviceServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "DeviceAgentConfig",
			Handler:    _AgentDeviceService_DeviceAgentConfig_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "app/agent/v1/agent.proto",
}

AgentDeviceService_ServiceDesc is the grpc.ServiceDesc for AgentDeviceService service. It's only intended for direct use with grpc.RegisterService, and not to be introspected or modified (even as a copy)

View Source 
var File_app_agent_v1_agent_proto protoreflect.FileDescriptor

Functions

func RegisterAgentDeviceServiceHandler 

func RegisterAgentDeviceServiceHandler(ctx context.Context, mux *runtime.ServeMux, conn *grpc.ClientConn) error

RegisterAgentDeviceServiceHandler registers the http handlers for service AgentDeviceService to "mux". The handlers forward requests to the grpc endpoint over "conn".

func RegisterAgentDeviceServiceHandlerClient 

func RegisterAgentDeviceServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client AgentDeviceServiceClient) error

RegisterAgentDeviceServiceHandlerClient registers the http handlers for service AgentDeviceService to "mux". The handlers forward requests to the grpc endpoint over the given implementation of "AgentDeviceServiceClient". Note: the gRPC framework executes interceptors within the gRPC handler. If the passed in "AgentDeviceServiceClient" doesn't go through the normal gRPC flow (creating a gRPC client etc.) then it will be up to the passed in "AgentDeviceServiceClient" to call the correct interceptors.

func RegisterAgentDeviceServiceHandlerFromEndpoint 

func RegisterAgentDeviceServiceHandlerFromEndpoint(ctx context.Context, mux *runtime.ServeMux, endpoint string, opts []grpc.DialOption) (err error)

RegisterAgentDeviceServiceHandlerFromEndpoint is same as RegisterAgentDeviceServiceHandler but automatically dials to "endpoint" and closes the connection when "ctx" gets done.

func RegisterAgentDeviceServiceHandlerServer 

func RegisterAgentDeviceServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server AgentDeviceServiceServer) error

RegisterAgentDeviceServiceHandlerServer registers the http handlers for service AgentDeviceService to "mux". UnaryRPC :call AgentDeviceServiceServer directly. StreamingRPC :currently unsupported pending https://github.com/grpc/grpc-go/issues/906. Note that using this registration option will cause many gRPC library features to stop working. Consider using RegisterAgentDeviceServiceHandlerFromEndpoint instead.

func RegisterAgentDeviceServiceServer 

func RegisterAgentDeviceServiceServer(s grpc.ServiceRegistrar, srv AgentDeviceServiceServer)

Types

type AgentDeviceServiceClient 

type AgentDeviceServiceClient interface {
	// DeviceAgentConfig is for retrieving config by the on-device agent.
	DeviceAgentConfig(ctx context.Context, in *DeviceAgentConfigRequest, opts ...grpc.CallOption) (*DeviceAgentConfigResponse, error)
}

AgentDeviceServiceClient is the client API for AgentDeviceService service.

For semantics around ctx use and closing/ending streaming RPCs, please refer to https://pkg.go.dev/google.golang.org/grpc/?tab=doc#ClientConn.NewStream.

func NewAgentDeviceServiceClient 

func NewAgentDeviceServiceClient(cc grpc.ClientConnInterface) AgentDeviceServiceClient

type AgentDeviceServiceServer 

type AgentDeviceServiceServer interface {
	// DeviceAgentConfig is for retrieving config by the on-device agent.
	DeviceAgentConfig(context.Context, *DeviceAgentConfigRequest) (*DeviceAgentConfigResponse, error)
	// contains filtered or unexported methods
}

AgentDeviceServiceServer is the server API for AgentDeviceService service. All implementations must embed UnimplementedAgentDeviceServiceServer for forward compatibility

type DeviceAgentConfigRequest 

type DeviceAgentConfigRequest struct {

	// robot partID
	Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"`
	// info about the host system
	HostInfo *HostInfo `protobuf:"bytes,2,opt,name=host_info,json=hostInfo,proto3" json:"host_info,omitempty"`
	// current subsystems and versions
	// DEPRECATED in favor of version_info
	//
	// Deprecated: Marked as deprecated in app/agent/v1/agent.proto.
	SubsystemVersions map[string]string `` /* 200-byte string literal not displayed */
	// Currently installed versions for agent and viam-server
	VersionInfo *VersionInfo `protobuf:"bytes,4,opt,name=version_info,json=versionInfo,proto3" json:"version_info,omitempty"`
	// contains filtered or unexported fields
}

Device side

func (*DeviceAgentConfigRequest) Descriptor deprecated 

func (*DeviceAgentConfigRequest) Descriptor() ([]byte, []int)

Deprecated: Use DeviceAgentConfigRequest.ProtoReflect.Descriptor instead.

func (*DeviceAgentConfigRequest) GetHostInfo 

func (x *DeviceAgentConfigRequest) GetHostInfo() *HostInfo

func (*DeviceAgentConfigRequest) GetId 

func (x *DeviceAgentConfigRequest) GetId() string

func (*DeviceAgentConfigRequest) GetSubsystemVersions deprecated 

func (x *DeviceAgentConfigRequest) GetSubsystemVersions() map[string]string

Deprecated: Marked as deprecated in app/agent/v1/agent.proto.

func (*DeviceAgentConfigRequest) GetVersionInfo added in v0.1.394 

func (x *DeviceAgentConfigRequest) GetVersionInfo() *VersionInfo

func (*DeviceAgentConfigRequest) ProtoMessage 

func (*DeviceAgentConfigRequest) ProtoMessage()

func (*DeviceAgentConfigRequest) ProtoReflect 

func (x *DeviceAgentConfigRequest) ProtoReflect() protoreflect.Message

func (*DeviceAgentConfigRequest) Reset 

func (x *DeviceAgentConfigRequest) Reset()

func (*DeviceAgentConfigRequest) String 

func (x *DeviceAgentConfigRequest) String() string

type DeviceAgentConfigResponse 

type DeviceAgentConfigResponse struct {

	// subsystems to be installed/configured/updated
	// note: previously installed subsystems will be removed from the system if removed from this list
	// DEPRECATED in favor of indidivual update_info and settings fields
	//
	// Deprecated: Marked as deprecated in app/agent/v1/agent.proto.
	SubsystemConfigs map[string]*DeviceSubsystemConfig `` /* 197-byte string literal not displayed */
	// how often this request should be repeated
	CheckInterval *durationpb.Duration `protobuf:"bytes,2,opt,name=check_interval,json=checkInterval,proto3" json:"check_interval,omitempty"`
	// update info for agent and viam-server, parsed/processed in App
	AgentUpdateInfo      *UpdateInfo `protobuf:"bytes,3,opt,name=agent_update_info,json=agentUpdateInfo,proto3" json:"agent_update_info,omitempty"`
	ViamServerUpdateInfo *UpdateInfo `protobuf:"bytes,4,opt,name=viam_server_update_info,json=viamServerUpdateInfo,proto3" json:"viam_server_update_info,omitempty"`
	// various settings that are passed directly to device Agent
	AdvancedSettings     *structpb.Struct `protobuf:"bytes,5,opt,name=advanced_settings,json=advancedSettings,proto3" json:"advanced_settings,omitempty"`
	NetworkConfiguration *structpb.Struct `protobuf:"bytes,6,opt,name=network_configuration,json=networkConfiguration,proto3" json:"network_configuration,omitempty"`
	AdditionalNetworks   *structpb.Struct `protobuf:"bytes,7,opt,name=additional_networks,json=additionalNetworks,proto3" json:"additional_networks,omitempty"`
	SystemConfiguration  *structpb.Struct `protobuf:"bytes,8,opt,name=system_configuration,json=systemConfiguration,proto3" json:"system_configuration,omitempty"`
	// contains filtered or unexported fields
}

func (*DeviceAgentConfigResponse) Descriptor deprecated 

func (*DeviceAgentConfigResponse) Descriptor() ([]byte, []int)

Deprecated: Use DeviceAgentConfigResponse.ProtoReflect.Descriptor instead.

func (*DeviceAgentConfigResponse) GetAdditionalNetworks added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetAdditionalNetworks() *structpb.Struct

func (*DeviceAgentConfigResponse) GetAdvancedSettings added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetAdvancedSettings() *structpb.Struct

func (*DeviceAgentConfigResponse) GetAgentUpdateInfo added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetAgentUpdateInfo() *UpdateInfo

func (*DeviceAgentConfigResponse) GetCheckInterval 

func (x *DeviceAgentConfigResponse) GetCheckInterval() *durationpb.Duration

func (*DeviceAgentConfigResponse) GetNetworkConfiguration added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetNetworkConfiguration() *structpb.Struct

func (*DeviceAgentConfigResponse) GetSubsystemConfigs deprecated 

func (x *DeviceAgentConfigResponse) GetSubsystemConfigs() map[string]*DeviceSubsystemConfig

Deprecated: Marked as deprecated in app/agent/v1/agent.proto.

func (*DeviceAgentConfigResponse) GetSystemConfiguration added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetSystemConfiguration() *structpb.Struct

func (*DeviceAgentConfigResponse) GetViamServerUpdateInfo added in v0.1.394 

func (x *DeviceAgentConfigResponse) GetViamServerUpdateInfo() *UpdateInfo

func (*DeviceAgentConfigResponse) ProtoMessage 

func (*DeviceAgentConfigResponse) ProtoMessage()

func (*DeviceAgentConfigResponse) ProtoReflect 

func (x *DeviceAgentConfigResponse) ProtoReflect() protoreflect.Message

func (*DeviceAgentConfigResponse) Reset 

func (x *DeviceAgentConfigResponse) Reset()

func (*DeviceAgentConfigResponse) String 

func (x *DeviceAgentConfigResponse) String() string

type DeviceSubsystemConfig deprecated 

type DeviceSubsystemConfig struct {

	// data needed to download/validate the subsystem
	UpdateInfo *UpdateInfo `protobuf:"bytes,1,opt,name=update_info,json=updateInfo,proto3" json:"update_info,omitempty"`
	// if this subsystem is disabled and should not be started by the agent
	Disable bool `protobuf:"varint,2,opt,name=disable,proto3" json:"disable,omitempty"`
	// force_restart will restart the subsystem, even if no updates are available
	ForceRestart bool `protobuf:"varint,3,opt,name=force_restart,json=forceRestart,proto3" json:"force_restart,omitempty"`
	// arbitrary config sections
	Attributes *structpb.Struct `protobuf:"bytes,4,opt,name=attributes,proto3" json:"attributes,omitempty"`
	// contains filtered or unexported fields
}

DEPRECATED as of January 2025

Deprecated: Marked as deprecated in app/agent/v1/agent.proto.

func (*DeviceSubsystemConfig) Descriptor deprecated 

func (*DeviceSubsystemConfig) Descriptor() ([]byte, []int)

Deprecated: Use DeviceSubsystemConfig.ProtoReflect.Descriptor instead.

func (*DeviceSubsystemConfig) GetAttributes added in v0.1.254 

func (x *DeviceSubsystemConfig) GetAttributes() *structpb.Struct

func (*DeviceSubsystemConfig) GetDisable 

func (x *DeviceSubsystemConfig) GetDisable() bool

func (*DeviceSubsystemConfig) GetForceRestart 

func (x *DeviceSubsystemConfig) GetForceRestart() bool

func (*DeviceSubsystemConfig) GetUpdateInfo 

func (x *DeviceSubsystemConfig) GetUpdateInfo() *UpdateInfo

func (*DeviceSubsystemConfig) ProtoMessage 

func (*DeviceSubsystemConfig) ProtoMessage()

func (*DeviceSubsystemConfig) ProtoReflect 

func (x *DeviceSubsystemConfig) ProtoReflect() protoreflect.Message

func (*DeviceSubsystemConfig) Reset 

func (x *DeviceSubsystemConfig) Reset()

func (*DeviceSubsystemConfig) String 

func (x *DeviceSubsystemConfig) String() string

type HostInfo 

type HostInfo struct {

	// platform is the docker styled combination of kernel and architecture. Ex: linux/amd64, darwin/arm64
	Platform string `protobuf:"bytes,1,opt,name=platform,proto3" json:"platform,omitempty"`
	// ID and VERSION_ID fields from /etc/os-release, colon seperated. Ex: ubuntu:22.04, debian:11
	Distro string `protobuf:"bytes,2,opt,name=distro,proto3" json:"distro,omitempty"`
	// additional tags for specific hardware or software that's present and may affect software selection
	// ex: "jetson", "rpi4", "systemd", etc.
	Tags []string `protobuf:"bytes,3,rep,name=tags,proto3" json:"tags,omitempty"`
	// contains filtered or unexported fields
}

func (*HostInfo) Descriptor deprecated 

func (*HostInfo) Descriptor() ([]byte, []int)

Deprecated: Use HostInfo.ProtoReflect.Descriptor instead.

func (*HostInfo) GetDistro 

func (x *HostInfo) GetDistro() string

func (*HostInfo) GetPlatform 

func (x *HostInfo) GetPlatform() string

func (*HostInfo) GetTags 

func (x *HostInfo) GetTags() []string

func (*HostInfo) ProtoMessage 

func (*HostInfo) ProtoMessage()

func (*HostInfo) ProtoReflect 

func (x *HostInfo) ProtoReflect() protoreflect.Message

func (*HostInfo) Reset 

func (x *HostInfo) Reset()

func (*HostInfo) String 

func (x *HostInfo) String() string

type PackageFormat 

type PackageFormat int32
const (
	// unknown/unset (autodetection may be attempted)
	PackageFormat_PACKAGE_FORMAT_UNSPECIFIED PackageFormat = 0
	// do nothing
	PackageFormat_PACKAGE_FORMAT_RAW PackageFormat = 1
	// decompress .xz file
	PackageFormat_PACKAGE_FORMAT_XZ PackageFormat = 2
	// set executable permissions
	PackageFormat_PACKAGE_FORMAT_EXECUTABLE PackageFormat = 3
	// decompress and set executable
	PackageFormat_PACKAGE_FORMAT_XZ_EXECUTABLE PackageFormat = 4
)

func (PackageFormat) Descriptor 

func (PackageFormat) Descriptor() protoreflect.EnumDescriptor

func (PackageFormat) Enum 

func (x PackageFormat) Enum() *PackageFormat

func (PackageFormat) EnumDescriptor deprecated 

func (PackageFormat) EnumDescriptor() ([]byte, []int)

Deprecated: Use PackageFormat.Descriptor instead.

func (PackageFormat) Number 

func (x PackageFormat) Number() protoreflect.EnumNumber

func (PackageFormat) String 

func (x PackageFormat) String() string

func (PackageFormat) Type 

func (PackageFormat) Type() protoreflect.EnumType

type UnimplementedAgentDeviceServiceServer 

type UnimplementedAgentDeviceServiceServer struct {
}

UnimplementedAgentDeviceServiceServer must be embedded to have forward compatible implementations.

func (UnimplementedAgentDeviceServiceServer) DeviceAgentConfig 

func (UnimplementedAgentDeviceServiceServer) DeviceAgentConfig(context.Context, *DeviceAgentConfigRequest) (*DeviceAgentConfigResponse, error)

type UnsafeAgentDeviceServiceServer 

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

UnsafeAgentDeviceServiceServer may be embedded to opt out of forward compatibility for this service. Use of this interface is not recommended, as added methods to AgentDeviceServiceServer will result in compilation errors.

type UpdateInfo added in v0.1.394 

type UpdateInfo struct {

	// unpacked filename as it is expected on disk (regardless of url)
	Filename string `protobuf:"bytes,1,opt,name=filename,proto3" json:"filename,omitempty"`
	// url to download from
	Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"`
	// version expected at the url
	Version string `protobuf:"bytes,3,opt,name=version,proto3" json:"version,omitempty"`
	// sha256 sum of file as downloaded
	Sha256 []byte `protobuf:"bytes,4,opt,name=sha256,proto3" json:"sha256,omitempty"`
	// determines if decompression or executable permissions are needed
	Format PackageFormat `protobuf:"varint,5,opt,name=format,proto3,enum=viam.app.agent.v1.PackageFormat" json:"format,omitempty"`
	// contains filtered or unexported fields
}

func (*UpdateInfo) Descriptor deprecated added in v0.1.394 

func (*UpdateInfo) Descriptor() ([]byte, []int)

Deprecated: Use UpdateInfo.ProtoReflect.Descriptor instead.

func (*UpdateInfo) GetFilename added in v0.1.394 

func (x *UpdateInfo) GetFilename() string

func (*UpdateInfo) GetFormat added in v0.1.394 

func (x *UpdateInfo) GetFormat() PackageFormat

func (*UpdateInfo) GetSha256 added in v0.1.394 

func (x *UpdateInfo) GetSha256() []byte

func (*UpdateInfo) GetUrl added in v0.1.394 

func (x *UpdateInfo) GetUrl() string

func (*UpdateInfo) GetVersion added in v0.1.394 

func (x *UpdateInfo) GetVersion() string

func (*UpdateInfo) ProtoMessage added in v0.1.394 

func (*UpdateInfo) ProtoMessage()

func (*UpdateInfo) ProtoReflect added in v0.1.394 

func (x *UpdateInfo) ProtoReflect() protoreflect.Message

func (*UpdateInfo) Reset added in v0.1.394 

func (x *UpdateInfo) Reset()

func (*UpdateInfo) String added in v0.1.394 

func (x *UpdateInfo) String() string

type VersionInfo added in v0.1.394 

type VersionInfo struct {

	// the version of agent currently running and making the request
	AgentRunning string `protobuf:"bytes,1,opt,name=agent_running,json=agentRunning,proto3" json:"agent_running,omitempty"`
	// the version of agent installed (will run after restart if different)
	AgentInstalled string `protobuf:"bytes,2,opt,name=agent_installed,json=agentInstalled,proto3" json:"agent_installed,omitempty"`
	// the version of viam-server currently running
	ViamServerRunning string `protobuf:"bytes,3,opt,name=viam_server_running,json=viamServerRunning,proto3" json:"viam_server_running,omitempty"`
	// the version of viam-server installed (will run after restart if different)
	ViamServerInstalled string `protobuf:"bytes,4,opt,name=viam_server_installed,json=viamServerInstalled,proto3" json:"viam_server_installed,omitempty"`
	// contains filtered or unexported fields
}

func (*VersionInfo) Descriptor deprecated added in v0.1.394 

func (*VersionInfo) Descriptor() ([]byte, []int)

Deprecated: Use VersionInfo.ProtoReflect.Descriptor instead.

func (*VersionInfo) GetAgentInstalled added in v0.1.394 

func (x *VersionInfo) GetAgentInstalled() string

func (*VersionInfo) GetAgentRunning added in v0.1.394 

func (x *VersionInfo) GetAgentRunning() string

func (*VersionInfo) GetViamServerInstalled added in v0.1.394 

func (x *VersionInfo) GetViamServerInstalled() string

func (*VersionInfo) GetViamServerRunning added in v0.1.394 

func (x *VersionInfo) GetViamServerRunning() string

func (*VersionInfo) ProtoMessage added in v0.1.394 

func (*VersionInfo) ProtoMessage()

func (*VersionInfo) ProtoReflect added in v0.1.394 

func (x *VersionInfo) ProtoReflect() protoreflect.Message

func (*VersionInfo) Reset added in v0.1.394 

func (x *VersionInfo) Reset()

func (*VersionInfo) String added in v0.1.394 

func (x *VersionInfo) String() string

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.