restore

Documentation

Overview

Restores a snapshot.

Index

• Variables
• type NewRestore
  • func NewRestoreFunc(tp elastictransport.Interface) NewRestore
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
• type Restore
  • func New(tp elastictransport.Interface) *Restore
  • func (r Restore) Do(providedCtx context.Context) (*Response, error)
  • func (r *Restore) ErrorTrace(errortrace bool) *Restore
  • func (r *Restore) FeatureStates(featurestates ...string) *Restore
  • func (r *Restore) FilterPath(filterpaths ...string) *Restore
  • func (r *Restore) Header(key, value string) *Restore
  • func (r *Restore) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Restore) Human(human bool) *Restore
  • func (r *Restore) IgnoreIndexSettings(ignoreindexsettings ...string) *Restore
  • func (r *Restore) IgnoreUnavailable(ignoreunavailable bool) *Restore
  • func (r *Restore) IncludeAliases(includealiases bool) *Restore
  • func (r *Restore) IncludeGlobalState(includeglobalstate bool) *Restore
  • func (r *Restore) IndexSettings(indexsettings *types.IndexSettings) *Restore
  • func (r *Restore) Indices(indices ...string) *Restore
  • func (r *Restore) MasterTimeout(duration string) *Restore
  • func (r *Restore) Partial(partial bool) *Restore
  • func (r Restore) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Restore) Pretty(pretty bool) *Restore
  • func (r *Restore) Raw(raw io.Reader) *Restore
  • func (r *Restore) RenamePattern(renamepattern string) *Restore
  • func (r *Restore) RenameReplacement(renamereplacement string) *Restore
  • func (r *Restore) Request(req *Request) *Restore
  • func (r *Restore) WaitForCompletion(waitforcompletion bool) *Restore

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 NewRestore

type NewRestore func(repository, snapshot string) *Restore

NewRestore type alias for index.

func NewRestoreFunc

func NewRestoreFunc(tp elastictransport.Interface) NewRestore

NewRestoreFunc returns a new instance of Restore 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 {
	FeatureStates       []string             `json:"feature_states,omitempty"`
	IgnoreIndexSettings []string             `json:"ignore_index_settings,omitempty"`
	IgnoreUnavailable   *bool                `json:"ignore_unavailable,omitempty"`
	IncludeAliases      *bool                `json:"include_aliases,omitempty"`
	IncludeGlobalState  *bool                `json:"include_global_state,omitempty"`
	IndexSettings       *types.IndexSettings `json:"index_settings,omitempty"`
	Indices             []string             `json:"indices,omitempty"`
	Partial             *bool                `json:"partial,omitempty"`
	RenamePattern       *string              `json:"rename_pattern,omitempty"`
	RenameReplacement   *string              `json:"rename_replacement,omitempty"`
}

Request holds the request body struct for the package restore

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/snapshot/restore/SnapshotRestoreRequest.ts#L25-L51

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	Accepted *bool                  `json:"accepted,omitempty"`
	Snapshot *types.SnapshotRestore `json:"snapshot,omitempty"`
}

Response holds the response body struct for the package restore

https://github.com/elastic/elasticsearch-specification/blob/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/snapshot/restore/SnapshotRestoreResponse.ts#L23-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type Restore

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

func New

func New(tp elastictransport.Interface) *Restore

Restores a snapshot.

https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html

func (Restore) Do

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

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

func (*Restore) ErrorTrace

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

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

func (*Restore) FeatureStates

func (r *Restore) FeatureStates(featurestates ...string) *Restore

API name: feature_states

func (*Restore) FilterPath

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

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

func (*Restore) Header

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

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

func (*Restore) HttpRequest

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

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

func (*Restore) Human

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

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 (*Restore) IgnoreIndexSettings

func (r *Restore) IgnoreIndexSettings(ignoreindexsettings ...string) *Restore

API name: ignore_index_settings

func (*Restore) IgnoreUnavailable

func (r *Restore) IgnoreUnavailable(ignoreunavailable bool) *Restore

API name: ignore_unavailable

func (*Restore) IncludeAliases

func (r *Restore) IncludeAliases(includealiases bool) *Restore

API name: include_aliases

func (*Restore) IncludeGlobalState

func (r *Restore) IncludeGlobalState(includeglobalstate bool) *Restore

API name: include_global_state

func (*Restore) IndexSettings

func (r *Restore) IndexSettings(indexsettings *types.IndexSettings) *Restore

API name: index_settings

func (*Restore) Indices

func (r *Restore) Indices(indices ...string) *Restore

API name: indices

func (*Restore) MasterTimeout

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

MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout

func (*Restore) Partial

func (r *Restore) Partial(partial bool) *Restore

API name: partial

func (Restore) Perform

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

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

func (*Restore) Pretty

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

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

func (*Restore) Raw

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

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

func (*Restore) RenamePattern

func (r *Restore) RenamePattern(renamepattern string) *Restore

API name: rename_pattern

func (*Restore) RenameReplacement

func (r *Restore) RenameReplacement(renamereplacement string) *Restore

API name: rename_replacement

func (*Restore) Request

func (r *Restore) Request(req *Request) *Restore

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

func (*Restore) WaitForCompletion

func (r *Restore) WaitForCompletion(waitforcompletion bool) *Restore

WaitForCompletion Should this request wait until the operation has completed before returning API name: wait_for_completion