cmd

Documentation

Index

• Variables
• func Execute() error
• type DMRecord
• type DOIRecord
• type MCDataRecord
• type MCResponse
• type MLInput
• type MapRecord
• type MaterialsCommons
• type MetaData
• type MetaDataRecord
• type ResponseRecord
• type SpecScans
• type SpecScansRecord
• type StorageRecord
• type UploadRecord
• type UrlParams

Variables

var StaticFs embed.FS

Functions

func Execute

func Execute() error

Execute executes the root command.

Types

type DMRecord

type DMRecord struct {
	Name  string `json:"name"`
	Path  string `json:"path"`
	IsDir bool   `json:"is_dir"`
}

DMRecord represents DataManagement record

type DOIRecord

type DOIRecord struct {
	Doi            string `json:"doi"`
	DoiUrl         string `json:"doi_url"`
	Did            string `json:"did"`
	Description    string `json:"description"`
	Provider       string `json:"doi_provider"`
	Published      string `json:"doi_created_at"`
	Public         bool   `json:"doi_public"`
	AccessMetadata bool   `json:"doi_access_metadata"`
}

DOIServiceResponse represents response structure of DOIService record

type MCDataRecord

type MCDataRecord struct {
	Status string             `json:"status"`
	Data   []MaterialsCommons `json:"data"`
}

MetaDataRecord represents MetaData record returned by discovery service

type MCResponse

type MCResponse struct {
	Data []map[string]any `json:"data"`
}

MCResponse represents HTTP response from Material Commons API

type MLInput

type MLInput struct {
	Model   string `json:"model"`
	Type    string `json:"type"`
	Backend string `json:"backend"`
	File    string `json:"file",omitempty`
	Version string `json:"version",omitempty`
}

MLInput represents input for predict API

type MapRecord

type MapRecord map[string]any

type MaterialsCommons

type MaterialsCommons struct {
	ID          string   `json:"id"`
	Site        string   `json:"site"`
	Description string   `json:"description"`
	Tags        []string `json:"tags"`
	Bucket      string   `json:"bucket"`
}

helper function to get metadata MaterialsCommons represents MaterialsCommons object returned from discovery service

type MetaData

type MetaData struct {
	ID          string   `json:"id"`
	Site        string   `json:"site"`
	Description string   `json:"description"`
	Tags        []string `json:"tags"`
	Bucket      string   `json:"bucket"`
}

helper function to get metadata MetaData represents MetaData object returned from discovery service

type MetaDataRecord

type MetaDataRecord struct {
	Status string     `json:"status"`
	Data   []MetaData `json:"data"`
}

MetaDataRecord represents MetaData record returned by discovery service

type ResponseRecord

type ResponseRecord struct {
	Status string `json:"status"`
	Error  string `json:"error"`
}

ResponseRecord represents MetaData record returned by discovery service

type SpecScans

type SpecScans struct {
	ID          string   `json:"id"`
	Site        string   `json:"site"`
	Description string   `json:"description"`
	Tags        []string `json:"tags"`
	Bucket      string   `json:"bucket"`
}

helper function to get specdata SpecScans represents SpecScans object returned from discovery service

type SpecScansRecord

type SpecScansRecord struct {
	Status string      `json:"status"`
	Data   []SpecScans `json:"data"`
}

SpecScansRecord represents SpecScans record returned by discovery service

type StorageRecord

type StorageRecord struct {
	Status string `json:"status"`
	Data   any    `json:"data"`
}

StorageRecord represents Storage record returned by datamanagement service

type UploadRecord

type UploadRecord struct {
	Status string `json:"status"`
	Error  string `json:"error"`
	Msg    string `json:"msg"`
	Object any    `json:"object"`
}

UploadRecord represents Storage record returned by datamanagement service

type UrlParams

type UrlParams struct {
	Did         string `url:"did"`
	File        string `url:"file"`
	Script      string `url:"script"`
	Environment string `url:"environment"`
	Package     string `url:"package"`
	Site        string `url:"site"`
	Bucket      string `url:"bucket"`
	Processing  string `url:"processing"`
	Osname      string `url:"osname"`
}

UrlParams represents all possible parameters we can pass to datasets query