restore

package
v8.13.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 12 Imported by: 3

Documentation

Overview

Restores a snapshot.

Index

Constants

This section is empty.

Variables

View Source 
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.

Functions

This section is empty.

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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/snapshot/restore/SnapshotRestoreRequest.ts#L25-L51

func NewRequest added in v8.5.0 

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0 

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

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON added in v8.12.1 

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

type Response added in v8.7.0 

type Response struct {
	Snapshot types.SnapshotRestore `json:"snapshot"`
}

Response holds the response body struct for the package restore

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/snapshot/restore/SnapshotRestoreResponse.ts#L23-L25

func NewResponse added in v8.7.0 

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) FeatureStates added in v8.9.0 

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

API name: feature_states

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) IgnoreIndexSettings added in v8.9.0 

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

API name: ignore_index_settings

func (*Restore) IgnoreUnavailable added in v8.9.0 

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

API name: ignore_unavailable

func (*Restore) IncludeAliases added in v8.9.0 

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

API name: include_aliases

func (*Restore) IncludeGlobalState added in v8.9.0 

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

API name: include_global_state

func (*Restore) IndexSettings added in v8.9.0 

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

API name: index_settings

func (*Restore) Indices added in v8.9.0 

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 added in v8.9.0 

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

API name: partial

func (Restore) Perform added in v8.7.0 

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) 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 added in v8.9.0 

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

API name: rename_pattern

func (*Restore) RenameReplacement added in v8.9.0 

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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.