runnerapi

Documentation

Index

• func List(params ListParams) (*models.RunnerOverview, error)
• func Resync(params ResyncParams) error
• func ResyncAll(params ResyncAllParams) (*models.ModelVersionIndexSynchronizationResults, error)
• func Search(params SearchParams) (*models.RunnerOverview, error)
• func Show(params ShowParams) (*models.RunnerInfo, error)
• type ListParams
  • func (params ListParams) Validate() error
• type ResyncAllParams
  • func (params ResyncAllParams) Validate() error
• type ResyncParams
  • func (params ResyncParams) Validate() error
• type SearchParams
  • func (params SearchParams) Validate() error
• type ShowParams
  • func (params ShowParams) Validate() error

Functions

func List

func List(params ListParams) (*models.RunnerOverview, error)

List gets the list of runners

func Resync

func Resync(params ResyncParams) error

Resync forces indexer to immediately resynchronize the search index and cache for a given runner.

func ResyncAll

func ResyncAll(params ResyncAllParams) (*models.ModelVersionIndexSynchronizationResults, error)

ResyncAll asynchronously resynchronizes the search index for all runners.

func Search

func Search(params SearchParams) (*models.RunnerOverview, error)

Search searches all the runners using Query DSL

func Show

func Show(params ShowParams) (*models.RunnerInfo, error)

Show returns information about a specific runner

Types

type ListParams

type ListParams struct {
	*api.API
	Region string
}

ListParams is the generic set of parameters used for any runner call

func (ListParams) Validate

func (params ListParams) Validate() error

Validate checks the parameters

type ResyncAllParams

type ResyncAllParams struct {
	*api.API
	Region string
}

ResyncAllParams is consumed by Resync

func (ResyncAllParams) Validate

func (params ResyncAllParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type ResyncParams

type ResyncParams struct {
	*api.API
	Region string
	ID     string
}

ResyncParams is consumed by Resync

func (ResyncParams) Validate

func (params ResyncParams) Validate() error

Validate ensures the parameters are usable by the consuming function.

type SearchParams

type SearchParams struct {
	*api.API
	Region  string
	Request models.SearchRequest
}

SearchParams contains parameters used to search runner's data using Query DSL

func (SearchParams) Validate

func (params SearchParams) Validate() error

Validate is the implementation for the ecctl.Validator interface

type ShowParams

type ShowParams struct {
	*api.API
	Region string
	ID     string
}

ShowParams is the set of parameters required for

func (ShowParams) Validate

func (params ShowParams) Validate() error

Validate checks the parameters