migratetodatatiers

Documentation

Overview

Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

Index

• Variables
• type MigrateToDataTiers
  • func New(tp elastictransport.Interface) *MigrateToDataTiers
  • func (r MigrateToDataTiers) Do(ctx context.Context) (*http.Response, error)
  • func (r *MigrateToDataTiers) DryRun(b bool) *MigrateToDataTiers
  • func (r *MigrateToDataTiers) Header(key, value string) *MigrateToDataTiers
  • func (r *MigrateToDataTiers) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *MigrateToDataTiers) Raw(raw json.RawMessage) *MigrateToDataTiers
  • func (r *MigrateToDataTiers) Request(req *Request) *MigrateToDataTiers
• type NewMigrateToDataTiers
  • func NewMigrateToDataTiersFunc(tp elastictransport.Interface) NewMigrateToDataTiers
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) LegacyTemplateToDelete(legacytemplatetodelete string) *RequestBuilder
  • func (rb *RequestBuilder) NodeAttribute(nodeattribute string) *RequestBuilder

Variables

var ErrBuildPath = errors.New("cannot build path, check for missing path parameters")

ErrBuildPath is returned in case of missing parameters within the build of the request.

Types

type MigrateToDataTiers

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

func New

func New(tp elastictransport.Interface) *MigrateToDataTiers

Migrates the indices and ILM policies away from custom node attribute allocation routing to data tiers routing

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-migrate-to-data-tiers.html

func (MigrateToDataTiers) Do

func (r MigrateToDataTiers) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*MigrateToDataTiers) DryRun

func (r *MigrateToDataTiers) DryRun(b bool) *MigrateToDataTiers

DryRun If true, simulates the migration from node attributes based allocation filters to data tiers, but does not perform the migration. This provides a way to retrieve the indices and ILM policies that need to be migrated. API name: dry_run

func (*MigrateToDataTiers) Header

func (r *MigrateToDataTiers) Header(key, value string) *MigrateToDataTiers

Header set a key, value pair in the MigrateToDataTiers headers map.

func (*MigrateToDataTiers) HttpRequest

func (r *MigrateToDataTiers) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*MigrateToDataTiers) Raw

func (r *MigrateToDataTiers) Raw(raw json.RawMessage) *MigrateToDataTiers

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*MigrateToDataTiers) Request

func (r *MigrateToDataTiers) Request(req *Request) *MigrateToDataTiers

Request allows to set the request property with the appropriate payload.

type NewMigrateToDataTiers

type NewMigrateToDataTiers func() *MigrateToDataTiers

NewMigrateToDataTiers type alias for index.

func NewMigrateToDataTiersFunc

func NewMigrateToDataTiersFunc(tp elastictransport.Interface) NewMigrateToDataTiers

NewMigrateToDataTiersFunc returns a new instance of MigrateToDataTiers with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request struct {
	LegacyTemplateToDelete *string `json:"legacy_template_to_delete,omitempty"`

	NodeAttribute *string `json:"node_attribute,omitempty"`
}

Request holds the request body struct for the package migratetodatatiers

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/ilm/migrate_to_data_tiers/Request.ts#L22-L44

type RequestBuilder

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

RequestBuilder is the builder API for the migratetodatatiers.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) LegacyTemplateToDelete

func (rb *RequestBuilder) LegacyTemplateToDelete(legacytemplatetodelete string) *RequestBuilder

func (*RequestBuilder) NodeAttribute

func (rb *RequestBuilder) NodeAttribute(nodeattribute string) *RequestBuilder