restore

Documentation

Overview

Restores a snapshot.

Index

• Variables
• type NewRestore
  • func NewRestoreFunc(tp elastictransport.Interface) NewRestore
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) IgnoreIndexSettings(ignore_index_settings ...string) *RequestBuilder
  • func (rb *RequestBuilder) IgnoreUnavailable(ignoreunavailable bool) *RequestBuilder
  • func (rb *RequestBuilder) IncludeAliases(includealiases bool) *RequestBuilder
  • func (rb *RequestBuilder) IncludeGlobalState(includeglobalstate bool) *RequestBuilder
  • func (rb *RequestBuilder) IndexSettings(indexsettings *types.IndexSettingsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Indices(indices *types.IndicesBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Partial(partial bool) *RequestBuilder
  • func (rb *RequestBuilder) RenamePattern(renamepattern string) *RequestBuilder
  • func (rb *RequestBuilder) RenameReplacement(renamereplacement string) *RequestBuilder
• type Restore
  • func New(tp elastictransport.Interface) *Restore
  • func (r Restore) Do(ctx context.Context) (*http.Response, error)
  • func (r *Restore) Header(key, value string) *Restore
  • func (r *Restore) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Restore) MasterTimeout(value string) *Restore
  • func (r *Restore) Raw(raw json.RawMessage) *Restore
  • func (r *Restore) Repository(v string) *Restore
  • func (r *Restore) Request(req *Request) *Restore
  • func (r *Restore) Snapshot(v string) *Restore
  • func (r *Restore) WaitForCompletion(b 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 {
	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 *types.Indices `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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/snapshot/restore/SnapshotRestoreRequest.ts#L25-L50

type RequestBuilder

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

RequestBuilder is the builder API for the restore.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) IgnoreIndexSettings

func (rb *RequestBuilder) IgnoreIndexSettings(ignore_index_settings ...string) *RequestBuilder

func (*RequestBuilder) IgnoreUnavailable

func (rb *RequestBuilder) IgnoreUnavailable(ignoreunavailable bool) *RequestBuilder

func (*RequestBuilder) IncludeAliases

func (rb *RequestBuilder) IncludeAliases(includealiases bool) *RequestBuilder

func (*RequestBuilder) IncludeGlobalState

func (rb *RequestBuilder) IncludeGlobalState(includeglobalstate bool) *RequestBuilder

func (*RequestBuilder) IndexSettings

func (rb *RequestBuilder) IndexSettings(indexsettings *types.IndexSettingsBuilder) *RequestBuilder

func (*RequestBuilder) Indices

func (rb *RequestBuilder) Indices(indices *types.IndicesBuilder) *RequestBuilder

func (*RequestBuilder) Partial

func (rb *RequestBuilder) Partial(partial bool) *RequestBuilder

func (*RequestBuilder) RenamePattern

func (rb *RequestBuilder) RenamePattern(renamepattern string) *RequestBuilder

func (*RequestBuilder) RenameReplacement

func (rb *RequestBuilder) RenameReplacement(renamereplacement string) *RequestBuilder

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/master/modules-snapshots.html

func (Restore) Do

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

Do runs the http.Request through the provided transport.

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) MasterTimeout

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

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

func (*Restore) Raw

func (r *Restore) Raw(raw json.RawMessage) *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) Repository

func (r *Restore) Repository(v string) *Restore

Repository A repository name API Name: repository

func (*Restore) Request

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

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

func (*Restore) Snapshot

func (r *Restore) Snapshot(v string) *Restore

Snapshot A snapshot name API Name: snapshot

func (*Restore) WaitForCompletion

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

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