constructor

Documentation

Index

• func DisableMaintenance(params MaintenanceParams) error
• func EnableMaintenace(params MaintenanceParams) error
• func Get(params GetParams) (*models.ConstructorInfo, error)
• func List(params Params) (*models.ConstructorOverview, error)
• func Resync(params ResyncParams) error
• func ResyncAll(params Params) (*models.ModelVersionIndexSynchronizationResults, error)
• type GetParams
  • func (params GetParams) Validate() error
• type MaintenanceParams
  • func (params MaintenanceParams) Validate() error
• type Params
  • func (params Params) Validate() error
• type ResyncParams
  • func (params ResyncParams) Validate() error

Functions

func DisableMaintenance

func DisableMaintenance(params MaintenanceParams) error

DisableMaintenance unsets the constructor to operational mode

func EnableMaintenace

func EnableMaintenace(params MaintenanceParams) error

EnableMaintenace sets the constructor to operational mode

func Get

func Get(params GetParams) (*models.ConstructorInfo, error)

Get returns information about a specific constructor

func List

func List(params Params) (*models.ConstructorOverview, error)

List gets the list of constuctors for a region

func Resync

func Resync(params ResyncParams) error

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

func ResyncAll

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

ResyncAll asynchronously resynchronizes the search index for all constructors.

Types

type GetParams

type GetParams struct {
	Params
	ID string
}

GetParams is the set of parameters required for

func (GetParams) Validate

func (params GetParams) Validate() error

Validate checks the parameters

type MaintenanceParams

type MaintenanceParams struct {
	Params
	ID string
}

MaintenanceParams is the set of parameters required for EnableMaintenace and DisableMaintenance

func (MaintenanceParams) Validate

func (params MaintenanceParams) Validate() error

Validate checks the parameters

type Params

type Params struct {
	*api.API
}

Params is the generic set of parameters used for any constructor call

func (Params) Validate

func (params Params) Validate() error

Validate checks the parameters

type ResyncParams

type ResyncParams struct {
	*api.API
	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.