node

package

v0.0.0-...-60df2ce Latest Latest Go to latest Published: Feb 28, 2026 License: MIT Imports: 13 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/retr0h/osapi

Links

Open Source Insights

Documentation ¶

Overview ¶

Package node provides node-related API handlers.

Index ¶

type Node
- func New(logger *slog.Logger, jobClient client.JobClient) *Node

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Node ¶

type Node struct {
	// JobClient provides job-based operations for system queries.
	JobClient client.JobClient
	// contains filtered or unexported fields
}

Node implementation of the Node APIs operations.

func New ¶

func New(
	logger *slog.Logger,
	jobClient client.JobClient,
) *Node

New factory to create a new instance.

func (*Node) GetNodeDisk ¶

func (s *Node) GetNodeDisk(
	ctx context.Context,
	request gen.GetNodeDiskRequestObject,
) (gen.GetNodeDiskResponseObject, error)

GetNodeDisk get the node disk usage API endpoint.

func (*Node) GetNodeHostname ¶

func (s *Node) GetNodeHostname(
	ctx context.Context,
	request gen.GetNodeHostnameRequestObject,
) (gen.GetNodeHostnameResponseObject, error)

GetNodeHostname get the node hostname API endpoint.

func (*Node) GetNodeLoad ¶

func (s *Node) GetNodeLoad(
	ctx context.Context,
	request gen.GetNodeLoadRequestObject,
) (gen.GetNodeLoadResponseObject, error)

GetNodeLoad get the node load averages API endpoint.

func (*Node) GetNodeMemory ¶

func (s *Node) GetNodeMemory(
	ctx context.Context,
	request gen.GetNodeMemoryRequestObject,
) (gen.GetNodeMemoryResponseObject, error)

GetNodeMemory get the node memory stats API endpoint.

func (*Node) GetNodeNetworkDNSByInterface ¶

func (s *Node) GetNodeNetworkDNSByInterface(
	ctx context.Context,
	request gen.GetNodeNetworkDNSByInterfaceRequestObject,
) (gen.GetNodeNetworkDNSByInterfaceResponseObject, error)

GetNodeNetworkDNSByInterface get the node network dns get API endpoint.

func (*Node) GetNodeOS ¶

func (s *Node) GetNodeOS(
	ctx context.Context,
	request gen.GetNodeOSRequestObject,
) (gen.GetNodeOSResponseObject, error)

GetNodeOS get the node OS info API endpoint.

func (*Node) GetNodeStatus ¶

func (s *Node) GetNodeStatus(
	ctx context.Context,
	request gen.GetNodeStatusRequestObject,
) (gen.GetNodeStatusResponseObject, error)

GetNodeStatus get the node status API endpoint.

func (*Node) GetNodeUptime ¶

func (s *Node) GetNodeUptime(
	ctx context.Context,
	request gen.GetNodeUptimeRequestObject,
) (gen.GetNodeUptimeResponseObject, error)

GetNodeUptime get the node uptime API endpoint.

func (*Node) PostNodeCommandExec ¶

func (s *Node) PostNodeCommandExec(
	ctx context.Context,
	request gen.PostNodeCommandExecRequestObject,
) (gen.PostNodeCommandExecResponseObject, error)

PostNodeCommandExec post the node command exec API endpoint.

func (*Node) PostNodeCommandShell ¶

func (s *Node) PostNodeCommandShell(
	ctx context.Context,
	request gen.PostNodeCommandShellRequestObject,
) (gen.PostNodeCommandShellResponseObject, error)

PostNodeCommandShell post the node command shell API endpoint.

func (*Node) PostNodeNetworkPing ¶

func (s *Node) PostNodeNetworkPing(
	ctx context.Context,
	request gen.PostNodeNetworkPingRequestObject,
) (gen.PostNodeNetworkPingResponseObject, error)

PostNodeNetworkPing post the node network ping API endpoint.

func (*Node) PutNodeNetworkDNS ¶

func (s *Node) PutNodeNetworkDNS(
	ctx context.Context,
	request gen.PutNodeNetworkDNSRequestObject,
) (gen.PutNodeNetworkDNSResponseObject, error)

PutNodeNetworkDNS put the node network dns API endpoint.

Source Files ¶

View all Source files

Directories ¶

Path	Synopsis
gen Package gen contains generated code for the node API.	Package gen contains generated code for the node API.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL