writer

Documentation

Index

• type BuilderInfo
• type BuilderWriter
  • func NewJSON() BuilderWriter
  • func NewTOML() BuilderWriter
  • func NewYAML() BuilderWriter
• type BuilderWriterFactory
• type Factory
  • func NewFactory() *Factory
  • func (f *Factory) Writer(kind string) (BuilderWriter, error)
• type HumanReadable
  • func NewHumanReadable() *HumanReadable
  • func (h *HumanReadable) Print(logger logging.Logger, localRunImages []config.RunImage, ...) error
• type InspectOutput
• type JSON
• type Lifecycle
• type RunImage
• type SharedBuilderInfo
• type Stack
• type StructuredFormat
  • func (w *StructuredFormat) Print(logger logging.Logger, localRunImages []config.RunImage, ...) error
• type TOML
• type YAML

Types

type BuilderInfo

type BuilderInfo struct {
	Description            string                  `json:"description,omitempty" yaml:"description,omitempty" toml:"description,omitempty"`
	CreatedBy              builder.CreatorMetadata `json:"created_by" yaml:"created_by" toml:"created_by"`
	Stack                  Stack                   `json:"stack" yaml:"stack" toml:"stack"`
	Lifecycle              Lifecycle               `json:"lifecycle" yaml:"lifecycle" toml:"lifecycle"`
	RunImages              []RunImage              `json:"run_images" yaml:"run_images" toml:"run_images"`
	Buildpacks             []dist.ModuleInfo       `json:"buildpacks" yaml:"buildpacks" toml:"buildpacks"`
	pubbldr.DetectionOrder `json:"detection_order" yaml:"detection_order" toml:"detection_order"`
}

type BuilderWriter

type BuilderWriter interface {
	Print(
		logger logging.Logger,
		localRunImages []config.RunImage,
		local, remote *client.BuilderInfo,
		localErr, remoteErr error,
		builderInfo SharedBuilderInfo,
	) error
}

func NewJSON

func NewJSON() BuilderWriter

func NewTOML

func NewTOML() BuilderWriter

func NewYAML

func NewYAML() BuilderWriter

type BuilderWriterFactory

type BuilderWriterFactory interface {
	Writer(kind string) (BuilderWriter, error)
}

type Factory

type Factory struct{}

func NewFactory

func NewFactory() *Factory

func (*Factory) Writer

func (f *Factory) Writer(kind string) (BuilderWriter, error)

type HumanReadable

type HumanReadable struct{}

func NewHumanReadable

func NewHumanReadable() *HumanReadable

func (*HumanReadable) Print

func (h *HumanReadable) Print(
	logger logging.Logger,
	localRunImages []config.RunImage,
	local, remote *client.BuilderInfo,
	localErr, remoteErr error,
	builderInfo SharedBuilderInfo,
) error

type InspectOutput

type InspectOutput struct {
	SharedBuilderInfo
	RemoteInfo *BuilderInfo `json:"remote_info" yaml:"remote_info" toml:"remote_info"`
	LocalInfo  *BuilderInfo `json:"local_info" yaml:"local_info" toml:"local_info"`
}

type JSON

type JSON struct {
	StructuredFormat
}

type Lifecycle

type Lifecycle struct {
	builder.LifecycleInfo `yaml:"lifecycleinfo,inline"`
	BuildpackAPIs         builder.APIVersions `json:"buildpack_apis" yaml:"buildpack_apis" toml:"buildpack_apis"`
	PlatformAPIs          builder.APIVersions `json:"platform_apis" yaml:"platform_apis" toml:"platform_apis"`
}

type RunImage

type RunImage struct {
	Name           string `json:"name" yaml:"name" toml:"name"`
	UserConfigured bool   `json:"user_configured,omitempty" yaml:"user_configured,omitempty" toml:"user_configured,omitempty"`
}

type SharedBuilderInfo

type SharedBuilderInfo struct {
	Name      string `json:"builder_name" yaml:"builder_name" toml:"builder_name"`
	Trusted   bool   `json:"trusted" yaml:"trusted" toml:"trusted"`
	IsDefault bool   `json:"default" yaml:"default" toml:"default"`
}

type Stack

type Stack struct {
	ID     string   `json:"id" yaml:"id" toml:"id"`
	Mixins []string `json:"mixins,omitempty" yaml:"mixins,omitempty" toml:"mixins,omitempty"`
}

type StructuredFormat

type StructuredFormat struct {
	MarshalFunc func(interface{}) ([]byte, error)
}

func (*StructuredFormat) Print

func (w *StructuredFormat) Print(
	logger logging.Logger,
	localRunImages []config.RunImage,
	local, remote *client.BuilderInfo,
	localErr, remoteErr error,
	builderInfo SharedBuilderInfo,
) error

type TOML

type TOML struct {
	StructuredFormat
}

type YAML

type YAML struct {
	StructuredFormat
}