rollover

Documentation

Overview

Roll over to a new index. Creates a new index for a data stream or index alias.

Index

• Variables
• type NewRollover
  • func NewRolloverFunc(tp elastictransport.Interface) NewRollover
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type Rollover
  • func New(tp elastictransport.Interface) *Rollover
  • func (r *Rollover) Aliases(aliases map[string]types.Alias) *Rollover
  • func (r *Rollover) Conditions(conditions *types.RolloverConditions) *Rollover
  • func (r Rollover) Do(providedCtx context.Context) (*Response, error)
  • func (r *Rollover) DryRun(dryrun bool) *Rollover
  • func (r *Rollover) ErrorTrace(errortrace bool) *Rollover
  • func (r *Rollover) FilterPath(filterpaths ...string) *Rollover
  • func (r *Rollover) Header(key, value string) *Rollover
  • func (r *Rollover) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Rollover) Human(human bool) *Rollover
  • func (r *Rollover) Mappings(mappings *types.TypeMapping) *Rollover
  • func (r *Rollover) MasterTimeout(duration string) *Rollover
  • func (r *Rollover) NewIndex(newindex string) *Rollover
  • func (r Rollover) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Rollover) Pretty(pretty bool) *Rollover
  • func (r *Rollover) Raw(raw io.Reader) *Rollover
  • func (r *Rollover) Request(req *Request) *Rollover
  • func (r *Rollover) Settings(settings map[string]json.RawMessage) *Rollover
  • func (r *Rollover) Timeout(duration string) *Rollover
  • func (r *Rollover) WaitForActiveShards(waitforactiveshards string) *Rollover

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 NewRollover

type NewRollover func(alias string) *Rollover

NewRollover type alias for index.

func NewRolloverFunc

func NewRolloverFunc(tp elastictransport.Interface) NewRollover

NewRolloverFunc returns a new instance of Rollover 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 {

	// Aliases Aliases for the target index.
	// Data streams do not support this parameter.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// Conditions Conditions for the rollover.
	// If specified, Elasticsearch only performs the rollover if the current index
	// satisfies these conditions.
	// If this parameter is not specified, Elasticsearch performs the rollover
	// unconditionally.
	// If conditions are specified, at least one of them must be a `max_*`
	// condition.
	// The index will rollover if any `max_*` condition is satisfied and all `min_*`
	// conditions are satisfied.
	Conditions *types.RolloverConditions `json:"conditions,omitempty"`
	// Mappings Mapping for fields in the index.
	// If specified, this mapping can include field names, field data types, and
	// mapping paramaters.
	Mappings *types.TypeMapping `json:"mappings,omitempty"`
	// Settings Configuration options for the index.
	// Data streams do not support this parameter.
	Settings map[string]json.RawMessage `json:"settings,omitempty"`
}

Request holds the request body struct for the package rollover

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/rollover/IndicesRolloverRequest.ts#L29-L100

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {
	Acknowledged       bool            `json:"acknowledged"`
	Conditions         map[string]bool `json:"conditions"`
	DryRun             bool            `json:"dry_run"`
	NewIndex           string          `json:"new_index"`
	OldIndex           string          `json:"old_index"`
	RolledOver         bool            `json:"rolled_over"`
	ShardsAcknowledged bool            `json:"shards_acknowledged"`
}

Response holds the response body struct for the package rollover

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/indices/rollover/IndicesRolloverResponse.ts#L22-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Rollover

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

func New

func New(tp elastictransport.Interface) *Rollover

Roll over to a new index. Creates a new index for a data stream or index alias.

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-rollover-index.html

func (*Rollover) Aliases

func (r *Rollover) Aliases(aliases map[string]types.Alias) *Rollover

Aliases Aliases for the target index. Data streams do not support this parameter. API name: aliases

func (*Rollover) Conditions

func (r *Rollover) Conditions(conditions *types.RolloverConditions) *Rollover

Conditions Conditions for the rollover. If specified, Elasticsearch only performs the rollover if the current index satisfies these conditions. If this parameter is not specified, Elasticsearch performs the rollover unconditionally. If conditions are specified, at least one of them must be a `max_*` condition. The index will rollover if any `max_*` condition is satisfied and all `min_*` conditions are satisfied. API name: conditions

func (Rollover) Do

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

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

func (*Rollover) DryRun

func (r *Rollover) DryRun(dryrun bool) *Rollover

DryRun If `true`, checks whether the current index satisfies the specified conditions but does not perform a rollover. API name: dry_run

func (*Rollover) ErrorTrace

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

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

func (*Rollover) FilterPath

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

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

func (*Rollover) Header

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

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

func (*Rollover) HttpRequest

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

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

func (*Rollover) Human

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

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 (*Rollover) Mappings

func (r *Rollover) Mappings(mappings *types.TypeMapping) *Rollover

Mappings Mapping for fields in the index. If specified, this mapping can include field names, field data types, and mapping paramaters. API name: mappings

func (*Rollover) MasterTimeout

func (r *Rollover) MasterTimeout(duration string) *Rollover

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*Rollover) NewIndex

func (r *Rollover) NewIndex(newindex string) *Rollover

NewIndex Name of the index to create. Supports date math. Data streams do not support this parameter. API Name: newindex

func (Rollover) Perform

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

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

func (*Rollover) Pretty

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

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

func (*Rollover) Raw

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

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

func (*Rollover) Request

func (r *Rollover) Request(req *Request) *Rollover

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

func (*Rollover) Settings

func (r *Rollover) Settings(settings map[string]json.RawMessage) *Rollover

Settings Configuration options for the index. Data streams do not support this parameter. API name: settings

func (*Rollover) Timeout

func (r *Rollover) Timeout(duration string) *Rollover

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*Rollover) WaitForActiveShards

func (r *Rollover) WaitForActiveShards(waitforactiveshards string) *Rollover

WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to all or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards