internal

Documentation

Index

• type AutoTagOption
  • func (ato AutoTagOption) ApplyToCreate(o *types.CreateOptions) error
• type FullObjectsOption
  • func (foo FullObjectsOption) ApplyToList(o *types.ListOptions) error
• type ObjectChannelOption
  • func (aoc ObjectChannelOption) ApplyToList(o *types.ListOptions) error
• type PagedOption
  • func (p PagedOption) ApplyToList(o *types.ListOptions) error

Types

type AutoTagOption

type AutoTagOption []string

AutoTagOption configures the Create operation to automatically tag objects after creation

func (AutoTagOption) ApplyToCreate

func (ato AutoTagOption) ApplyToCreate(o *types.CreateOptions) error

ApplyToCreate applies the AutoTagOption to the ListOptions

type FullObjectsOption

type FullObjectsOption bool

FullObjectsOption configures if the List operation shall make a Get operation for each object before returning it to the caller.

func (FullObjectsOption) ApplyToList

func (foo FullObjectsOption) ApplyToList(o *types.ListOptions) error

ApplyToList applies the FullObjectsOption option to all the ListOptions.

type ObjectChannelOption

type ObjectChannelOption struct {
	Channel *types.ObjectChannel
}

ObjectChannelOption configures the List operation to return the objects via the given channel.

func (ObjectChannelOption) ApplyToList

func (aoc ObjectChannelOption) ApplyToList(o *types.ListOptions) error

ApplyToList applies the AsObjectChannel option to all the ListOptions.

type PagedOption

type PagedOption struct {
	// Page to retrieve
	Page uint

	// Entries per page
	Limit uint

	// Additional output about the current page, includes a way to iterate through all pages.
	Info *types.PageInfo
}

PagedOption is an option valid for List operations to retrieve objects in a paged fashion (instead of all at once).

func (PagedOption) ApplyToList

func (p PagedOption) ApplyToList(o *types.ListOptions) error

ApplyToList applies the Paged option to all the ListOptions.