mount

Documentation

Overview

Mount a snapshot as a searchable index.

Index

• Variables
• type Mount
  • func New(tp elastictransport.Interface) *Mount
  • func (r Mount) Do(providedCtx context.Context) (*Response, error)
  • func (r *Mount) Header(key, value string) *Mount
  • func (r *Mount) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Mount) IgnoreIndexSettings(ignoreindexsettings ...string) *Mount
  • func (r *Mount) Index(indexname string) *Mount
  • func (r *Mount) IndexSettings(indexsettings map[string]json.RawMessage) *Mount
  • func (r *Mount) MasterTimeout(duration string) *Mount
  • func (r Mount) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Mount) Raw(raw io.Reader) *Mount
  • func (r *Mount) RenamedIndex(indexname string) *Mount
  • func (r *Mount) Request(req *Request) *Mount
  • func (r *Mount) Storage(storage string) *Mount
  • func (r *Mount) WaitForCompletion(waitforcompletion bool) *Mount
• type NewMount
  • func NewMountFunc(tp elastictransport.Interface) NewMount
• 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

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 Mount

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

func New

func New(tp elastictransport.Interface) *Mount

Mount a snapshot as a searchable index.

https://www.elastic.co/guide/en/elasticsearch/reference/current/searchable-snapshots-api-mount-snapshot.html

func (Mount) Do

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

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

func (*Mount) Header

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

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

func (*Mount) HttpRequest

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

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

func (*Mount) IgnoreIndexSettings

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

API name: ignore_index_settings

func (*Mount) Index

func (r *Mount) Index(indexname string) *Mount

API name: index

func (*Mount) IndexSettings

func (r *Mount) IndexSettings(indexsettings map[string]json.RawMessage) *Mount

API name: index_settings

func (*Mount) MasterTimeout

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

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

func (Mount) Perform

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

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

func (*Mount) Raw

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

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

func (*Mount) RenamedIndex

func (r *Mount) RenamedIndex(indexname string) *Mount

API name: renamed_index

func (*Mount) Request

func (r *Mount) Request(req *Request) *Mount

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

func (*Mount) Storage

func (r *Mount) Storage(storage string) *Mount

Storage Selects the kind of local storage used to accelerate searches. Experimental, and defaults to `full_copy` API name: storage

func (*Mount) WaitForCompletion

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

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

type NewMount

type NewMount func(repository, snapshot string) *Mount

NewMount type alias for index.

func NewMountFunc

func NewMountFunc(tp elastictransport.Interface) NewMount

NewMountFunc returns a new instance of Mount 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"`
	Index               string                     `json:"index"`
	IndexSettings       map[string]json.RawMessage `json:"index_settings,omitempty"`
	RenamedIndex        *string                    `json:"renamed_index,omitempty"`
}

Request holds the request body struct for the package mount

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/searchable_snapshots/mount/SearchableSnapshotsMountRequest.ts#L26-L49

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 {
	Snapshot types.MountedSnapshot `json:"snapshot"`
}

Response holds the response body struct for the package mount

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/searchable_snapshots/mount/SearchableSnapshotsMountResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response