ufs

Documentation

Overview

Package ufs is a labservice internal package that contains types and functions related to UFS interaction.

Index

• type ClientFactory
  • func (f *ClientFactory) NewClient(ctx context.Context) (ufsapi.FleetClient, error)
• type DeviceType
• type Inventory
  • func NewInventory(c ufsapi.FleetClient, cl *cache.Locator) *Inventory
  • func (inv *Inventory) GetDutTopology(ctx context.Context, id string) (*labapi.DutTopology, error)

Types

type ClientFactory

type ClientFactory struct {
	// UFS gRPC service address.
	Service string
	// Path to service account JSON file.
	ServiceAccountPath string
}

A ClientFactory is used to create UFS clients. The client needs a context which is request specific, so the client needs to be created per incoming request.

func (*ClientFactory) NewClient

func (f *ClientFactory) NewClient(ctx context.Context) (ufsapi.FleetClient, error)

type DeviceType

type DeviceType int64

const (
	ChromeOSDevice DeviceType = iota
	AndroidDevice
)

type Inventory

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

Inventory builds the DutTopology object from UFS.

func NewInventory

func NewInventory(c ufsapi.FleetClient, cl *cache.Locator) *Inventory

func (*Inventory) GetDutTopology

func (inv *Inventory) GetDutTopology(ctx context.Context, id string) (*labapi.DutTopology, error)

GetDutTopology returns a DutTopology constructed from UFS. The returned error, if any, has gRPC status information.