_go

package
v0.0.0-...-8df008b Latest Latest
Warning

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

Go to latest
Published: Nov 13, 2023 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Overview

Package _go is a reverse proxy.

It translates gRPC into RESTful JSON APIs.

Index

Constants

This section is empty.

Variables

View Source
var File_inventory_proto protoreflect.FileDescriptor
View Source
var InventoryService_ServiceDesc = grpc.ServiceDesc{
	ServiceName: "opi_api.inventory.v1.InventoryService",
	HandlerType: (*InventoryServiceServer)(nil),
	Methods: []grpc.MethodDesc{
		{
			MethodName: "GetInventory",
			Handler:    _InventoryService_GetInventory_Handler,
		},
	},
	Streams:  []grpc.StreamDesc{},
	Metadata: "inventory.proto",
}

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

Functions

func RegisterInventoryServiceHandler

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

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

func RegisterInventoryServiceHandlerClient

func RegisterInventoryServiceHandlerClient(ctx context.Context, mux *runtime.ServeMux, client InventoryServiceClient) error

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

func RegisterInventoryServiceHandlerFromEndpoint

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

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

func RegisterInventoryServiceHandlerServer

func RegisterInventoryServiceHandlerServer(ctx context.Context, mux *runtime.ServeMux, server InventoryServiceServer) error

RegisterInventoryServiceHandlerServer registers the http handlers for service InventoryService to "mux". UnaryRPC :call InventoryServiceServer 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 RegisterInventoryServiceHandlerFromEndpoint instead.

func RegisterInventoryServiceServer

func RegisterInventoryServiceServer(s grpc.ServiceRegistrar, srv InventoryServiceServer)

Types

type BIOSInfo

type BIOSInfo struct {

	// String number of the BIOS Vendor’s Name.
	Vendor string `protobuf:"bytes,1,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// String number of the BIOS Version. This value is a
	// free-form string that may contain Core and OEM
	// version information.
	Version string `protobuf:"bytes,2,opt,name=version,proto3" json:"version,omitempty"`
	// String number of the BIOS release date. The date
	// string, if supplied, is in either mm/dd/yy or
	// mm/dd/yyyy format. If the year portion of the string
	// is two digits, the year is assumed to be 19yy.
	// NOTE: In version 2.3 and later of SMBIOS the mm/dd/yyyy
	// format is only used.
	Date string `protobuf:"bytes,3,opt,name=date,proto3" json:"date,omitempty"`
	// contains filtered or unexported fields
}

BIOS Information (Type 0)

func (*BIOSInfo) Descriptor deprecated

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

Deprecated: Use BIOSInfo.ProtoReflect.Descriptor instead.

func (*BIOSInfo) GetDate

func (x *BIOSInfo) GetDate() string

func (*BIOSInfo) GetVendor

func (x *BIOSInfo) GetVendor() string

func (*BIOSInfo) GetVersion

func (x *BIOSInfo) GetVersion() string

func (*BIOSInfo) ProtoMessage

func (*BIOSInfo) ProtoMessage()

func (*BIOSInfo) ProtoReflect

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

func (*BIOSInfo) Reset

func (x *BIOSInfo) Reset()

func (*BIOSInfo) String

func (x *BIOSInfo) String() string

type BaseboardInfo

type BaseboardInfo struct {

	// Number of a null-terminated string
	AssetTag string `protobuf:"bytes,1,opt,name=asset_tag,json=assetTag,proto3" json:"asset_tag,omitempty"`
	// Number of null-terminated string
	SerialNumber string `protobuf:"bytes,2,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
	// Number of null-terminated string
	Vendor string `protobuf:"bytes,3,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// Number of null-terminated string
	Version string `protobuf:"bytes,4,opt,name=version,proto3" json:"version,omitempty"`
	// Number of null-terminated string
	Product string `protobuf:"bytes,5,opt,name=product,proto3" json:"product,omitempty"`
	// contains filtered or unexported fields
}

Baseboard (or Module) Information (Type 2)

The information in this structure defines attributes of a system baseboard (for
example, a motherboard, planar, server blade, or other standard system module)

func (*BaseboardInfo) Descriptor deprecated

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

Deprecated: Use BaseboardInfo.ProtoReflect.Descriptor instead.

func (*BaseboardInfo) GetAssetTag

func (x *BaseboardInfo) GetAssetTag() string

func (*BaseboardInfo) GetProduct

func (x *BaseboardInfo) GetProduct() string

func (*BaseboardInfo) GetSerialNumber

func (x *BaseboardInfo) GetSerialNumber() string

func (*BaseboardInfo) GetVendor

func (x *BaseboardInfo) GetVendor() string

func (*BaseboardInfo) GetVersion

func (x *BaseboardInfo) GetVersion() string

func (*BaseboardInfo) ProtoMessage

func (*BaseboardInfo) ProtoMessage()

func (*BaseboardInfo) ProtoReflect

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

func (*BaseboardInfo) Reset

func (x *BaseboardInfo) Reset()

func (*BaseboardInfo) String

func (x *BaseboardInfo) String() string

type CPUInfo

type CPUInfo struct {

	// Number of cores per processor socket
	// See 7.5.6. If the value is unknown, the field is set
	// to 0. For core counts of 256 or greater, the Core
	// Count field is set to FFh and the Core Count 2
	// field is set to the number of cores.
	TotalCores int32 `protobuf:"varint,1,opt,name=total_cores,json=totalCores,proto3" json:"total_cores,omitempty"`
	// Number of threads per processor socket
	// See 7.5.8. If the value is unknown, the field is set
	// to 0. For thread counts of 256 or greater, the
	// Thread Count field is set to FFh and the Thread
	// Count 2 field is set to the number of threads.
	TotalThreads int32 `protobuf:"varint,2,opt,name=total_threads,json=totalThreads,proto3" json:"total_threads,omitempty"`
	// contains filtered or unexported fields
}

Processor Information (Type 4)

The information in this structure (see Table 21) defines the attributes of a single processor; a separate
structure instance is provided for each system processor socket/slot. For example, a system with an
IntelDX2™ processor would have a single structure instance while a system with an IntelSX2™ processor
would have a structure to describe the main CPU and a second structure to describe the 80487 co1054 processor.

func (*CPUInfo) Descriptor deprecated

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

Deprecated: Use CPUInfo.ProtoReflect.Descriptor instead.

func (*CPUInfo) GetTotalCores

func (x *CPUInfo) GetTotalCores() int32

func (*CPUInfo) GetTotalThreads

func (x *CPUInfo) GetTotalThreads() int32

func (*CPUInfo) ProtoMessage

func (*CPUInfo) ProtoMessage()

func (*CPUInfo) ProtoReflect

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

func (*CPUInfo) Reset

func (x *CPUInfo) Reset()

func (*CPUInfo) String

func (x *CPUInfo) String() string

type ChassisInfo

type ChassisInfo struct {

	// Number of null-terminated string
	AssetTag string `protobuf:"bytes,1,opt,name=asset_tag,json=assetTag,proto3" json:"asset_tag,omitempty"`
	// Number of null-terminated string
	SerialNumber string `protobuf:"bytes,2,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
	// Bit 7 Chassis lock is present if 1.
	// Otherwise, either a lock is not present, or it is unknown if the enclosure has a lock.
	// Bits 6:0 Enumeration value; see below.
	Type string `protobuf:"bytes,3,opt,name=type,proto3" json:"type,omitempty"`
	// Table 17 shows the byte values for the System Enclosure or Chassis Types field
	// Number of null-terminated string
	TypeDescription string `protobuf:"bytes,4,opt,name=type_description,json=typeDescription,proto3" json:"type_description,omitempty"`
	// Number of null-terminated string
	Vendor string `protobuf:"bytes,5,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// Number of null-terminated string
	Version string `protobuf:"bytes,6,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

System Enclosure or Chassis (Type 3)

The information in this structure (see Table 16) defines attributes of the system’s mechanical
enclosure(s). For example, if a system included a separate enclosure for its peripheral devices, two
structures would be returned: one for the main system enclosure and the second for the peripheral device
enclosure. The additions to this structure in version 2.1 of this specification support the population of the
CIM_Chassis class.

func (*ChassisInfo) Descriptor deprecated

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

Deprecated: Use ChassisInfo.ProtoReflect.Descriptor instead.

func (*ChassisInfo) GetAssetTag

func (x *ChassisInfo) GetAssetTag() string

func (*ChassisInfo) GetSerialNumber

func (x *ChassisInfo) GetSerialNumber() string

func (*ChassisInfo) GetType

func (x *ChassisInfo) GetType() string

func (*ChassisInfo) GetTypeDescription

func (x *ChassisInfo) GetTypeDescription() string

func (*ChassisInfo) GetVendor

func (x *ChassisInfo) GetVendor() string

func (*ChassisInfo) GetVersion

func (x *ChassisInfo) GetVersion() string

func (*ChassisInfo) ProtoMessage

func (*ChassisInfo) ProtoMessage()

func (*ChassisInfo) ProtoReflect

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

func (*ChassisInfo) Reset

func (x *ChassisInfo) Reset()

func (*ChassisInfo) String

func (x *ChassisInfo) String() string

type GetInventoryRequest

type GetInventoryRequest struct {

	// The name of the inventory to retrieve - blank for the full inventory
	Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
	// contains filtered or unexported fields
}

Request for Retrieving Inventory data from a device

func (*GetInventoryRequest) Descriptor deprecated

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

Deprecated: Use GetInventoryRequest.ProtoReflect.Descriptor instead.

func (*GetInventoryRequest) GetName

func (x *GetInventoryRequest) GetName() string

func (*GetInventoryRequest) ProtoMessage

func (*GetInventoryRequest) ProtoMessage()

func (*GetInventoryRequest) ProtoReflect

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

func (*GetInventoryRequest) Reset

func (x *GetInventoryRequest) Reset()

func (*GetInventoryRequest) String

func (x *GetInventoryRequest) String() string

type Inventory

type Inventory struct {

	// BIOS Inventory
	Bios *BIOSInfo `protobuf:"bytes,1,opt,name=bios,proto3" json:"bios,omitempty"`
	// System Inventory
	System *SystemInfo `protobuf:"bytes,2,opt,name=system,proto3" json:"system,omitempty"`
	// Baseboard Inventory
	Baseboard *BaseboardInfo `protobuf:"bytes,3,opt,name=baseboard,proto3" json:"baseboard,omitempty"`
	// Chassis Inventory
	Chassis *ChassisInfo `protobuf:"bytes,4,opt,name=chassis,proto3" json:"chassis,omitempty"`
	// CPU Inventory
	Processor *CPUInfo `protobuf:"bytes,5,opt,name=processor,proto3" json:"processor,omitempty"`
	// Memory Inventory
	Memory *MemoryInfo `protobuf:"bytes,6,opt,name=memory,proto3" json:"memory,omitempty"`
	// PCI Devices Inventory
	Pci []*PCIeDeviceInfo `protobuf:"bytes,7,rep,name=pci,proto3" json:"pci,omitempty"`
	// contains filtered or unexported fields
}

Response for device inventory data

func (*Inventory) Descriptor deprecated

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

Deprecated: Use Inventory.ProtoReflect.Descriptor instead.

func (*Inventory) GetBaseboard

func (x *Inventory) GetBaseboard() *BaseboardInfo

func (*Inventory) GetBios

func (x *Inventory) GetBios() *BIOSInfo

func (*Inventory) GetChassis

func (x *Inventory) GetChassis() *ChassisInfo

func (*Inventory) GetMemory

func (x *Inventory) GetMemory() *MemoryInfo

func (*Inventory) GetPci

func (x *Inventory) GetPci() []*PCIeDeviceInfo

func (*Inventory) GetProcessor

func (x *Inventory) GetProcessor() *CPUInfo

func (*Inventory) GetSystem

func (x *Inventory) GetSystem() *SystemInfo

func (*Inventory) ProtoMessage

func (*Inventory) ProtoMessage()

func (*Inventory) ProtoReflect

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

func (*Inventory) Reset

func (x *Inventory) Reset()

func (*Inventory) String

func (x *Inventory) String() string

type InventoryServiceClient

type InventoryServiceClient interface {
	// retrieves the inventory data for the device
	GetInventory(ctx context.Context, in *GetInventoryRequest, opts ...grpc.CallOption) (*Inventory, error)
}

InventoryServiceClient is the client API for InventoryService 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.

type InventoryServiceServer

type InventoryServiceServer interface {
	// retrieves the inventory data for the device
	GetInventory(context.Context, *GetInventoryRequest) (*Inventory, error)
}

InventoryServiceServer is the server API for InventoryService service. All implementations should embed UnimplementedInventoryServiceServer for forward compatibility

type MemoryInfo

type MemoryInfo struct {

	// Maximum memory capacity, in kilobytes, for this array
	// If the capacity is not represented in this field, then this
	// field contains 8000 0000h and the Extended
	// Maximum Capacity field should be used. Values 2 TB
	// (8000 0000h) or greater must be represented in the
	// Extended Maximum Capacity field.
	TotalPhysicalBytes int64 `protobuf:"varint,1,opt,name=total_physical_bytes,json=totalPhysicalBytes,proto3" json:"total_physical_bytes,omitempty"`
	// TBD
	TotalUsableBytes int64 `protobuf:"varint,2,opt,name=total_usable_bytes,json=totalUsableBytes,proto3" json:"total_usable_bytes,omitempty"`
	// contains filtered or unexported fields
}

Physical Memory Array (Type 16)

This structure describes a collection of memory devices that operate together to form a memory address
space.

func (*MemoryInfo) Descriptor deprecated

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

Deprecated: Use MemoryInfo.ProtoReflect.Descriptor instead.

func (*MemoryInfo) GetTotalPhysicalBytes

func (x *MemoryInfo) GetTotalPhysicalBytes() int64

func (*MemoryInfo) GetTotalUsableBytes

func (x *MemoryInfo) GetTotalUsableBytes() int64

func (*MemoryInfo) ProtoMessage

func (*MemoryInfo) ProtoMessage()

func (*MemoryInfo) ProtoReflect

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

func (*MemoryInfo) Reset

func (x *MemoryInfo) Reset()

func (*MemoryInfo) String

func (x *MemoryInfo) String() string

type PCIeDeviceInfo

type PCIeDeviceInfo struct {

	// Driver assiociated with the device
	Driver string `protobuf:"bytes,1,opt,name=driver,proto3" json:"driver,omitempty"`
	// BDF address in a string format, for example "0000:00:17.7"
	Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
	// string vendor info
	Vendor string `protobuf:"bytes,3,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// string product info
	Product string `protobuf:"bytes,4,opt,name=product,proto3" json:"product,omitempty"`
	// string revision info
	Revision string `protobuf:"bytes,5,opt,name=revision,proto3" json:"revision,omitempty"`
	// string subsystem info
	Subsystem string `protobuf:"bytes,6,opt,name=subsystem,proto3" json:"subsystem,omitempty"`
	// string class info
	Class string `protobuf:"bytes,7,opt,name=class,proto3" json:"class,omitempty"`
	// string subclass info
	Subclass string `protobuf:"bytes,8,opt,name=subclass,proto3" json:"subclass,omitempty"`
	// contains filtered or unexported fields
}

PCI device information

TBD: Type 9 or Type 41 ?
This structure describes a collection of PCI devices.

func (*PCIeDeviceInfo) Descriptor deprecated

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

Deprecated: Use PCIeDeviceInfo.ProtoReflect.Descriptor instead.

func (*PCIeDeviceInfo) GetAddress

func (x *PCIeDeviceInfo) GetAddress() string

func (*PCIeDeviceInfo) GetClass

func (x *PCIeDeviceInfo) GetClass() string

func (*PCIeDeviceInfo) GetDriver

func (x *PCIeDeviceInfo) GetDriver() string

func (*PCIeDeviceInfo) GetProduct

func (x *PCIeDeviceInfo) GetProduct() string

func (*PCIeDeviceInfo) GetRevision

func (x *PCIeDeviceInfo) GetRevision() string

func (*PCIeDeviceInfo) GetSubclass

func (x *PCIeDeviceInfo) GetSubclass() string

func (*PCIeDeviceInfo) GetSubsystem

func (x *PCIeDeviceInfo) GetSubsystem() string

func (*PCIeDeviceInfo) GetVendor

func (x *PCIeDeviceInfo) GetVendor() string

func (*PCIeDeviceInfo) ProtoMessage

func (*PCIeDeviceInfo) ProtoMessage()

func (*PCIeDeviceInfo) ProtoReflect

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

func (*PCIeDeviceInfo) Reset

func (x *PCIeDeviceInfo) Reset()

func (*PCIeDeviceInfo) String

func (x *PCIeDeviceInfo) String() string

type SystemInfo

type SystemInfo struct {

	// Number of null-terminated string
	// This text string identifies the family to which a
	// particular computer belongs. A family refers to a
	// set of computers that are similar but not identical
	// from a hardware or software point of view.
	// Typically, a family is composed of different
	// computer models, which have different
	// configurations and pricing points. Computers in
	// the same family often have similar branding and
	// cosmetic features.
	Family string `protobuf:"bytes,1,opt,name=family,proto3" json:"family,omitempty"`
	// Number of null-terminated string
	Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"`
	// Number of null-terminated string
	Vendor string `protobuf:"bytes,3,opt,name=vendor,proto3" json:"vendor,omitempty"`
	// Number of null-terminated string
	SerialNumber string `protobuf:"bytes,4,opt,name=serial_number,json=serialNumber,proto3" json:"serial_number,omitempty"`
	// A UUID is an identifier that is designed to be unique across both time and space. It requires no central
	// registration process. The UUID is 128 bits long. Its format is described in RFC4122, but the actual field
	// contents are opaque and not significant to the SMBIOS specification, which is only concerned with the
	// byte order. Table 11 shows the field names; these field names, particularly for multiplexed fields, follow
	// historical practice.
	Uuid string `protobuf:"bytes,5,opt,name=uuid,proto3" json:"uuid,omitempty"`
	// Number of null-terminated string
	// This text string identifies a particular computer
	// configuration for sale. It is sometimes also called
	// a product ID or purchase order number. This
	// number is frequently found in existing fields, but
	// there is no standard format. Typically for a given
	// system board from a given OEM, there are tens
	// of unique processor, memory, hard drive, and
	// optical drive configurations.
	Sku string `protobuf:"bytes,6,opt,name=sku,proto3" json:"sku,omitempty"`
	// Number of null-terminated string
	Version string `protobuf:"bytes,7,opt,name=version,proto3" json:"version,omitempty"`
	// contains filtered or unexported fields
}

System Information (Type 1)

The information in this structure defines attributes of the overall system and is intended to be associated
with the Component ID group of the system’s MIF. An SMBIOS implementation is associated with a single
system instance and contains one and only one System Information (Type 1) structure. Table 10 shows
the contents of this structure.

func (*SystemInfo) Descriptor deprecated

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

Deprecated: Use SystemInfo.ProtoReflect.Descriptor instead.

func (*SystemInfo) GetFamily

func (x *SystemInfo) GetFamily() string

func (*SystemInfo) GetName

func (x *SystemInfo) GetName() string

func (*SystemInfo) GetSerialNumber

func (x *SystemInfo) GetSerialNumber() string

func (*SystemInfo) GetSku

func (x *SystemInfo) GetSku() string

func (*SystemInfo) GetUuid

func (x *SystemInfo) GetUuid() string

func (*SystemInfo) GetVendor

func (x *SystemInfo) GetVendor() string

func (*SystemInfo) GetVersion

func (x *SystemInfo) GetVersion() string

func (*SystemInfo) ProtoMessage

func (*SystemInfo) ProtoMessage()

func (*SystemInfo) ProtoReflect

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

func (*SystemInfo) Reset

func (x *SystemInfo) Reset()

func (*SystemInfo) String

func (x *SystemInfo) String() string

type UnimplementedInventoryServiceServer

type UnimplementedInventoryServiceServer struct {
}

UnimplementedInventoryServiceServer should be embedded to have forward compatible implementations.

func (UnimplementedInventoryServiceServer) GetInventory

type UnsafeInventoryServiceServer

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

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

Jump to

Keyboard shortcuts

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