data

package
v1.6.1 Latest Latest
Warning

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

Go to latest
Published: Nov 20, 2024 License: MIT Imports: 4 Imported by: 7

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AssignedTo

type AssignedTo struct {
	Mountpoint plans.Mountpoint `json:"mountpoint"`
	Run        runs.Summary     `json:"run"`
}

assigment representation, looking from data

func (AssignedTo) Equal

func (a AssignedTo) Equal(o AssignedTo) bool

type CreatedFrom added in v1.5.0

type CreatedFrom struct {
	// Mountpoint is the mountpoint which created this Data.
	//
	// This and Log are mutually exclusive.
	Mountpoint *plans.Mountpoint `json:"mountpoint,omitempty"`

	// Log is the log point which created this Data.
	//
	// This and Mountpoint are mutually exclusive.
	Log *plans.LogPoint `json:"log,omitempty"`

	// Run is the Run which created this Data.
	Run runs.Summary `json:"run"`
}

CreatedFrom represents the source of the data

func (CreatedFrom) Equal added in v1.5.0

func (c CreatedFrom) Equal(o CreatedFrom) bool

type Detail

type Detail struct {
	// KnitId is the id of the Data.
	KnitId string `json:"knitId"`

	// Tags are the tags of the Data.
	Tags []tags.Tag `json:"tags"`

	// Upstream is the upsteram Run and its mountpoint outputs this Data.
	Upstream CreatedFrom `json:"upstream"`

	// Downstreams are the downstream Runs and their mountpoint inputs this Data.
	Downstreams []AssignedTo `json:"downstreams"`

	// Nomination is the nominated Plan and its mountpoint can inputs this Data.
	Nomination []NominatedBy `json:"nomination"`
}

Detail is the format for response body from WebAPIs below:

- GET /api/data/[?...] (as list)

- POST /api/data/

- PUT /api/data/{knitId}

Other Data related WebAPI respones do not use this for response.

- GET /api/data/{knitId} : as binary stream (Content-Type: application/octet-stream)

func (Detail) Equal

func (d Detail) Equal(o Detail) bool

type NominatedBy

type NominatedBy struct {
	plans.Mountpoint
	Plan plans.Summary `json:"plan"`
}

nomination representation, looking from data

func (NominatedBy) Equal

func (n NominatedBy) Equal(o NominatedBy) bool

type Summary

type Summary struct {
	KnitId string     `json:"knitid"`
	Tags   []tags.Tag `json:"tags"`
}

func (*Summary) Equal

func (s *Summary) Equal(o *Summary) bool

Jump to

Keyboard shortcuts

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