clone

Documentation

Overview

Clones indices from one snapshot into another snapshot in the same repository.

Index

• Variables
• type Clone
  • func New(tp elastictransport.Interface) *Clone
  • func (r Clone) Do(ctx context.Context) (*Response, error)
  • func (r *Clone) Header(key, value string) *Clone
  • func (r *Clone) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *Clone) MasterTimeout(v string) *Clone
  • func (r Clone) Perform(ctx context.Context) (*http.Response, error)
  • func (r *Clone) Raw(raw io.Reader) *Clone
  • func (r *Clone) Repository(v string) *Clone
  • func (r *Clone) Request(req *Request) *Clone
  • func (r *Clone) Snapshot(v string) *Clone
  • func (r *Clone) TargetSnapshot(v string) *Clone
  • func (r *Clone) Timeout(v string) *Clone
• type NewClone
  • func NewCloneFunc(tp elastictransport.Interface) NewClone
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, 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 Clone

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

func New

func New(tp elastictransport.Interface) *Clone

Clones indices from one snapshot into another snapshot in the same repository.

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

func (Clone) Do

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

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

func (*Clone) Header

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

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

func (*Clone) HttpRequest

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

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

func (*Clone) MasterTimeout

func (r *Clone) MasterTimeout(v string) *Clone

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

func (Clone) Perform

func (r Clone) Perform(ctx context.Context) (*http.Response, error)

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

func (*Clone) Raw

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

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

func (*Clone) Repository

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

Repository A repository name API Name: repository

func (*Clone) Request

func (r *Clone) Request(req *Request) *Clone

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

func (*Clone) Snapshot

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

Snapshot The name of the snapshot to clone from API Name: snapshot

func (*Clone) TargetSnapshot

func (r *Clone) TargetSnapshot(v string) *Clone

TargetSnapshot The name of the cloned snapshot to create API Name: targetsnapshot

func (*Clone) Timeout

func (r *Clone) Timeout(v string) *Clone

API name: timeout

type NewClone

type NewClone func(repository, snapshot, targetsnapshot string) *Clone

NewClone type alias for index.

func NewCloneFunc

func NewCloneFunc(tp elastictransport.Interface) NewClone

NewCloneFunc returns a new instance of Clone 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 {
	Indices string `json:"indices"`
}

Request holds the request body struct for the package clone

https://github.com/elastic/elasticsearch-specification/blob/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/snapshot/clone/SnapshotCloneRequest.ts#L24-L42

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 For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response