k8svolume

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() (*corev1.Volume, error)
  • func (b *Builder) WithEmptyDir(dir *corev1.EmptyDirVolumeSource) *Builder
  • func (b *Builder) WithHostDirectory(path string) *Builder
  • func (b *Builder) WithHostPathAndType(dirpath string, dirtype *corev1.HostPathType) *Builder
  • func (b *Builder) WithName(name string) *Builder
  • func (b *Builder) WithPVCSource(pvcName string) *Builder
• type Predicate
  • func IsNil() Predicate
• type PredicateList
• type Volume
  • func NewForAPIObject(obj *corev1.Volume, opts ...volumeBuildOption) *Volume
  • func (v *Volume) IsNil() bool

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder is the builder object for Volume

func NewBuilder

func NewBuilder() *Builder

NewBuilder returns new instance of Builder

func (*Builder) Build

func (b *Builder) Build() (*corev1.Volume, error)

Build returns the Volume API instance

func (*Builder) WithEmptyDir

func (b *Builder) WithEmptyDir(dir *corev1.EmptyDirVolumeSource) *Builder

WithEmptyDir sets the EmptyDir field of the Volume with provided dir

func (*Builder) WithHostDirectory

func (b *Builder) WithHostDirectory(path string) *Builder

WithHostDirectory sets the VolumeSource field of Volume with provided hostpath as type directory.

func (*Builder) WithHostPathAndType

func (b *Builder) WithHostPathAndType(
	dirpath string,
	dirtype *corev1.HostPathType,
) *Builder

WithHostPathAndType sets the VolumeSource field of Volume with provided hostpath as directory path and type as directory type

func (*Builder) WithName

func (b *Builder) WithName(name string) *Builder

WithName sets the Name field of Volume with provided value.

func (*Builder) WithPVCSource

func (b *Builder) WithPVCSource(pvcName string) *Builder

WithPVCSource sets the Volume field of Volume with provided pvc

type Predicate

type Predicate func(*Volume) bool

Predicate defines an abstraction to determine conditional checks against the provided volume instance

func IsNil

func IsNil() Predicate

IsNil is predicate to filter out nil Volume instances

type PredicateList

type PredicateList []Predicate

PredicateList holds a list of predicate

type Volume

type Volume struct {
	// contains filtered or unexported fields
}

Volume is a wrapper over named volume api object, used within Pods. It provides build, validations and other common logic to be used by various feature specific callers.

func NewForAPIObject

func NewForAPIObject(obj *corev1.Volume, opts ...volumeBuildOption) *Volume

NewForAPIObject returns a new instance of Volume

func (*Volume) IsNil

func (v *Volume) IsNil() bool

IsNil returns true if the Volume instance is nil