createfrom

Documentation

Overview

Create an index from a source index.

Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

Index

• Variables
• type CreateFrom
  • func New(tp elastictransport.Interface) *CreateFrom
  • func (r CreateFrom) Do(providedCtx context.Context) (*Response, error)
  • func (r *CreateFrom) ErrorTrace(errortrace bool) *CreateFrom
  • func (r *CreateFrom) FilterPath(filterpaths ...string) *CreateFrom
  • func (r *CreateFrom) Header(key, value string) *CreateFrom
  • func (r *CreateFrom) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CreateFrom) Human(human bool) *CreateFrom
  • func (r *CreateFrom) MappingsOverride(mappingsoverride *types.TypeMapping) *CreateFrom
  • func (r CreateFrom) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *CreateFrom) Pretty(pretty bool) *CreateFrom
  • func (r *CreateFrom) Raw(raw io.Reader) *CreateFrom
  • func (r *CreateFrom) RemoveIndexBlocks(removeindexblocks bool) *CreateFrom
  • func (r *CreateFrom) Request(req *Request) *CreateFrom
  • func (r *CreateFrom) SettingsOverride(settingsoverride *types.IndexSettings) *CreateFrom
• type NewCreateFrom
  • func NewCreateFromFunc(tp elastictransport.Interface) NewCreateFrom
• type Request
  • func NewRequest() *Request
• type Response
  • func NewResponse() *Response

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 CreateFrom

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

func New

func New(tp elastictransport.Interface) *CreateFrom

Create an index from a source index.

Copy the mappings and settings from the source index to a destination index while allowing request settings and mappings to override the source values.

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

func (CreateFrom) Do

func (r CreateFrom) Do(providedCtx context.Context) (*Response, error)

Do runs the request through the transport, handle the response and returns a createfrom.Response

func (*CreateFrom) ErrorTrace

func (r *CreateFrom) ErrorTrace(errortrace bool) *CreateFrom

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*CreateFrom) FilterPath

func (r *CreateFrom) FilterPath(filterpaths ...string) *CreateFrom

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*CreateFrom) Header

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

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

func (*CreateFrom) HttpRequest

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

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

func (*CreateFrom) Human

func (r *CreateFrom) Human(human bool) *CreateFrom

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*CreateFrom) MappingsOverride

func (r *CreateFrom) MappingsOverride(mappingsoverride *types.TypeMapping) *CreateFrom

MappingsOverride Mappings overrides to be applied to the destination index (optional) API name: mappings_override

func (CreateFrom) Perform

func (r CreateFrom) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*CreateFrom) Pretty

func (r *CreateFrom) Pretty(pretty bool) *CreateFrom

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*CreateFrom) Raw

func (r *CreateFrom) Raw(raw io.Reader) *CreateFrom

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

func (*CreateFrom) RemoveIndexBlocks

func (r *CreateFrom) RemoveIndexBlocks(removeindexblocks bool) *CreateFrom

RemoveIndexBlocks If index blocks should be removed when creating destination index (optional) API name: remove_index_blocks

func (*CreateFrom) Request

func (r *CreateFrom) Request(req *Request) *CreateFrom

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

func (*CreateFrom) SettingsOverride

func (r *CreateFrom) SettingsOverride(settingsoverride *types.IndexSettings) *CreateFrom

SettingsOverride Settings overrides to be applied to the destination index (optional) API name: settings_override

type NewCreateFrom

type NewCreateFrom func(source, dest string) *CreateFrom

NewCreateFrom type alias for index.

func NewCreateFromFunc

func NewCreateFromFunc(tp elastictransport.Interface) NewCreateFrom

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

type Request

type Request = types.CreateFrom

Request holds the request body struct for the package createfrom

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/create_from/MigrateCreateFromRequest.ts#L25-L44

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

type Response

type Response struct {
	Acknowledged       bool   `json:"acknowledged"`
	Index              string `json:"index"`
	ShardsAcknowledged bool   `json:"shards_acknowledged"`
}

Response holds the response body struct for the package createfrom

https://github.com/elastic/elasticsearch-specification/blob/3a94b6715915b1e9311724a2614c643368eece90/specification/indices/create_from/MigrateCreateFromResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response