allocatorapi

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

type ListParams struct {
	// Required API instance.
	*api.API

	// Required region on which to perform the allocator list.
	Region string

	// Optional Elasticsearch search query.
	Query string

	// Optional filter tags with expected format: key:value slice. i.e.
	// [key:val, key:value].
	FilterTags string

	// Optional toggle to show all allocators (By default connected:false) are
	// omitted.
	ShowAll bool

	// Optional number of allocators to return (Defaults to 100).
	Size int64
}

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

type MetadataDeleteParams struct {
	*api.API
	ID, Key string
	Region  string
}

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

type MetadataSetParams struct {
	*api.API
	ID, Key, Value string
	Region         string
}

type PlanOverrides struct {
	// SkipSnapshot overwrites the Transient part of an Elastisearch vacate.
	SkipSnapshot      *bool
	SkipDataMigration *bool
	OverrideFailsafe  *bool
}

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

type VacateClusterParams struct {
	PreferredAllocators []string
	ClusterFilter       []string
	// Plan body overrides to place in all of the vacate clusters.
	PlanOverrides
	Region    string
	ID        string // allocatorID
	ClusterID string
	Kind      string
	*api.API
	TrackFrequency time.Duration
	AllocatorDown  *bool
	MoveOnly       *bool
	Output         *output.Device
	OutputFormat   string
	MaxPollRetries uint8
	SkipTracking   bool
}

type VacateError struct {
	AllocatorID string `json:"allocator_id,omitempty"`
	ResourceID  string `json:"resource_id,omitempty"`
	Kind        string `json:"kind,omitempty"`
	Ctx         string `json:"context,omitempty"`
	Err         error  `json:"error,omitempty"`
}

type VacateParams struct {
	*api.API

	Region string

	// List of allocators that will be marked to be vacated.
	Allocators []string

	// List of allocators to be used as potential targets.
	PreferredAllocators []string

	// Can specify a list of cluster IDs that will be moved
	// of N numbers of allocators.
	ClusterFilter []string

	// If specified it will only move clusters that match the kind
	// (elasticsearch, kibana).
	KindFilter string

	// Maximum number of concurrent cluster moves at any time.
	Concurrency uint16

	// Output device where the progress will be sent.
	Output *output.Device

	// OutputFormat to use
	OutputFormat string

	// Maximum number of errors to allow the plan status poller to tolerate.
	MaxPollRetries uint8

	// Poll frequency
	TrackFrequency time.Duration

	// Optional value to be set to the pool on construction.
	PoolTimeout pool.Timeout

	// Optional value to be set to override the default autodiscovery of an
	// allocator's health. This can only be used when a single allocator is
	// specified.
	AllocatorDown *bool

	// Optional value to be set to keep the cluster in its current -possibly broken- state and just does the
	// bare minimum to move the requested instances across to another allocator.
	MoveOnly *bool

	// SkipTracking skips displaying and waiting for the individual vacates to complete.
	// Setting it to true will render the concurrency flag pretty much ineffective since
	// the vacate action is asynchronous and the only thing keeping the working items in
	// the pool is the tracking function call which synchronously waits until the vacate
	// has effectively finished.
	SkipTracking bool

	// Plan body overrides to place in all of the vacate clusters.
	PlanOverrides
}