resource

Documentation

Overview

Package resource is an implementation of a Concourse resource.

Index

• type Resource
  • func (r *Resource) Check(source oc.Source, version oc.Version, env oc.Environment, logger *oc.Logger) ([]oc.Version, error)
  • func (r *Resource) In(outputDirectory string, source oc.Source, params oc.Params, version oc.Version, ...) (oc.Version, oc.Metadata, error)
  • func (r *Resource) Out(inputDirectory string, source oc.Source, params oc.Params, env oc.Environment, ...) (oc.Version, oc.Metadata, error)

Types

type Resource

type Resource struct{}

func (*Resource) Check

func (r *Resource) Check(source oc.Source, version oc.Version, env oc.Environment,
	logger *oc.Logger) ([]oc.Version, error)

Check implements the ofcourse.Resource Check method, corresponding to the /opt/resource/check command. This is called when Concourse does its resource checks, or when the `fly check-resource` command is run.

func (*Resource) In

func (r *Resource) In(outputDirectory string, source oc.Source, params oc.Params, version oc.Version,
	env oc.Environment, logger *oc.Logger) (oc.Version, oc.Metadata, error)

In implements the ofcourse.Resource In method, corresponding to the /opt/resource/in command. This is called when a Concourse job does `get` on the resource.

func (*Resource) Out

func (r *Resource) Out(inputDirectory string, source oc.Source, params oc.Params,
	env oc.Environment, logger *oc.Logger) (oc.Version, oc.Metadata, error)

Out implements the ofcourse.Resource Out method, corresponding to the /opt/resource/out command. This is called when a Concourse job does a `put` on the resource.