interfaces

Documentation

Index

• type AllocStateHandler
• type ArtifactGetter
• type Client
• type DeviceStatsReporter
• type EnvReplacer

Types

type AllocStateHandler

type AllocStateHandler interface {
	// AllocStateUpdated is used to emit an updated allocation. This allocation
	// is stripped to only include client settable fields.
	AllocStateUpdated(alloc *structs.Allocation)

	// PutAllocation is used to persist an updated allocation in the local state store.
	PutAllocation(*structs.Allocation) error
}

AllocStateHandler exposes a handler to be called when an allocation's state changes

type ArtifactGetter

type ArtifactGetter interface {
	// Get artifact and put it in the task directory.
	Get(taskEnv EnvReplacer, artifact *structs.TaskArtifact) error
}

ArtifactGetter is an interface satisfied by the getter package.

type Client

type Client interface {
	AllocStateHandler
}

type DeviceStatsReporter

type DeviceStatsReporter interface {
	LatestDeviceResourceStats([]*structs.AllocatedDeviceResource) []*device.DeviceGroupStats
}

DeviceStatsReporter gives access to the latest resource usage for devices

type EnvReplacer

type EnvReplacer interface {
	ReplaceEnv(string) string
	ClientPath(string, bool) (string, bool)
}

EnvReplacer is an interface which can interpolate environment variables and is usually satisfied by taskenv.TaskEnv.