client

package
v0.0.0-...-9004d47 Latest Latest
Warning

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

Go to latest
Published: Apr 27, 2024 License: MIT Imports: 15 Imported by: 0

Documentation

Overview

Package client GENERATED BY gengo:runtimedoc DON'T EDIT THIS FILE

Index

Constants

This section is empty.

Variables

View Source
var SecretPath = cue.ParsePath("$$secret")

Functions

This section is empty.

Types

type Any

type Any struct {
	Value any
}

func (Any) CueType

func (Any) CueType() []byte

func (Any) MarshalJSON

func (v Any) MarshalJSON() ([]byte, error)

func (Any) RuntimeDoc

func (v Any) RuntimeDoc(names ...string) ([]string, bool)

func (*Any) UnmarshalJSON

func (v *Any) UnmarshalJSON(data []byte) error

type EnvInterface

type EnvInterface struct {
	// to avoid added ok
	task.Task `json:"-"`

	RequiredEnv map[string]SecretOrString `json:"-"`
	OptionalEnv map[string]SecretOrString `json:"-"`
}

EnvInterface of client

func (EnvInterface) CacheDisabled

func (EnvInterface) CacheDisabled() bool

func (*EnvInterface) Do

func (ei *EnvInterface) Do(ctx context.Context) error

func (EnvInterface) OutputValues

func (ei EnvInterface) OutputValues() map[string]any

func (EnvInterface) RuntimeDoc

func (v EnvInterface) RuntimeDoc(names ...string) ([]string, bool)

func (*EnvInterface) UnmarshalTask

func (ei *EnvInterface) UnmarshalTask(t cueflow.Task) error

type GroupInterface

type GroupInterface struct {
	task.Group
}

Group

func (*GroupInterface) Do

func (x *GroupInterface) Do(ctx context.Context) error

func (GroupInterface) RuntimeDoc

func (v GroupInterface) RuntimeDoc(names ...string) ([]string, bool)

type Merge

type Merge struct {
	task.Task

	Inputs []Any `json:"inputs"`

	Output Any `json:"-" output:"output"`
}

Merge read secret value for the secret

func (*Merge) Do

func (e *Merge) Do(ctx context.Context) error

func (Merge) RuntimeDoc

func (v Merge) RuntimeDoc(names ...string) ([]string, bool)

type ReadSecret

type ReadSecret struct {
	task.Task

	// secret ref
	Secret Secret `json:"secret"`

	// secret value
	Value string `json:"-" output:"value"`
}

ReadSecret read secret value for the secret

func (*ReadSecret) Do

func (e *ReadSecret) Do(ctx context.Context) error

func (ReadSecret) RuntimeDoc

func (v ReadSecret) RuntimeDoc(names ...string) ([]string, bool)

type RevInfo

type RevInfo struct {
	task.Task

	// get pseudo version same of go mod
	// like
	//   v0.0.0-20231222030512-c093d5e89975
	//   v0.0.0-dirty.0.20231222022414-5f9d1d44dacc
	Version string `json:"-" output:"version"`
}

func (*RevInfo) Do

func (t *RevInfo) Do(ctx context.Context) error

func (RevInfo) RuntimeDoc

func (v RevInfo) RuntimeDoc(names ...string) ([]string, bool)

type Secret

type Secret struct {
	Ref struct {
		ID string `json:"id,omitempty"`
	} `json:"$$secret"`
}

func SecretOfID

func SecretOfID(id string) *Secret

func (Secret) RuntimeDoc

func (v Secret) RuntimeDoc(names ...string) ([]string, bool)

func (*Secret) Value

func (s *Secret) Value(ctx context.Context) (task.Secret, bool)

type SecretOrString

type SecretOrString struct {
	Secret *Secret
	Value  string
}

func (SecretOrString) MarshalJSON

func (s SecretOrString) MarshalJSON() ([]byte, error)

func (SecretOrString) OneOf

func (SecretOrString) OneOf() []any

func (SecretOrString) RuntimeDoc

func (v SecretOrString) RuntimeDoc(names ...string) ([]string, bool)

func (*SecretOrString) UnmarshalJSON

func (s *SecretOrString) UnmarshalJSON(data []byte) error

type Skip

type Skip struct {
	cueflow.FlowControlImpl

	When bool `json:"when"`
}

Skip will skip task when matched

func (Skip) RuntimeDoc

func (v Skip) RuntimeDoc(names ...string) ([]string, bool)

type StringOrBool

type StringOrBool struct {
	String string
	Bool   *bool
}

func (StringOrBool) MarshalJSON

func (s StringOrBool) MarshalJSON() ([]byte, error)

func (StringOrBool) OneOf

func (StringOrBool) OneOf() []any

func (StringOrBool) RuntimeDoc

func (v StringOrBool) RuntimeDoc(names ...string) ([]string, bool)

func (*StringOrBool) UnmarshalJSON

func (s *StringOrBool) UnmarshalJSON(data []byte) error

type StringOrBytes

type StringOrBytes []byte

func (StringOrBytes) MarshalJSON

func (s StringOrBytes) MarshalJSON() ([]byte, error)

func (StringOrBytes) OneOf

func (StringOrBytes) OneOf() []any

func (StringOrBytes) RuntimeDoc

func (StringOrBytes) RuntimeDoc(names ...string) ([]string, bool)

func (*StringOrBytes) UnmarshalJSON

func (s *StringOrBytes) UnmarshalJSON(data []byte) error

type StringOrSlice

type StringOrSlice []string

func (StringOrSlice) MarshalJSON

func (s StringOrSlice) MarshalJSON() ([]byte, error)

func (StringOrSlice) OneOf

func (StringOrSlice) OneOf() []any

func (StringOrSlice) RuntimeDoc

func (StringOrSlice) RuntimeDoc(names ...string) ([]string, bool)

func (*StringOrSlice) UnmarshalJSON

func (s *StringOrSlice) UnmarshalJSON(data []byte) error

type WaitInterface

type WaitInterface struct {
	task.Checkpoint

	// as assertion, one $ok is false
	// all task should break
	Ok bool `json:"$ok" default:"true"`
	// contains filtered or unexported fields
}

WaitInterface for wait task ready

func (*WaitInterface) OutputValues

func (ret *WaitInterface) OutputValues() map[string]any

func (WaitInterface) RuntimeDoc

func (v WaitInterface) RuntimeDoc(names ...string) ([]string, bool)

func (*WaitInterface) UnmarshalTask

func (ret *WaitInterface) UnmarshalTask(t cueflow.Task) error

Jump to

Keyboard shortcuts

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