clone

Documentation

Overview

Clones an index

Index

• Variables
• type Clone
  • func New(tp elastictransport.Interface) *Clone
  • func (r *Clone) Aliases(aliases map[string]types.Alias) *Clone
  • func (r Clone) Do(providedCtx 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(duration string) *Clone
  • func (r Clone) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Clone) Raw(raw io.Reader) *Clone
  • func (r *Clone) Request(req *Request) *Clone
  • func (r *Clone) Settings(settings map[string]json.RawMessage) *Clone
  • func (r *Clone) Timeout(duration string) *Clone
  • func (r *Clone) WaitForActiveShards(waitforactiveshards 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 an index

https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-clone-index.html

func (*Clone) Aliases

func (r *Clone) Aliases(aliases map[string]types.Alias) *Clone

Aliases Aliases for the resulting index. API name: aliases

func (Clone) Do

func (r Clone) Do(providedCtx 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(duration string) *Clone

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (Clone) Perform

func (r Clone) Perform(providedCtx 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) Request

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

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

func (*Clone) Settings

func (r *Clone) Settings(settings map[string]json.RawMessage) *Clone

Settings Configuration options for the target index. API name: settings

func (*Clone) Timeout

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

Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout

func (*Clone) WaitForActiveShards

func (r *Clone) WaitForActiveShards(waitforactiveshards string) *Clone

WaitForActiveShards The number of shard copies that must be active before proceeding with the operation. Set to `all` or any positive integer up to the total number of shards in the index (`number_of_replicas+1`). API name: wait_for_active_shards

type NewClone

type NewClone func(index, target 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 {

	// Aliases Aliases for the resulting index.
	Aliases map[string]types.Alias `json:"aliases,omitempty"`
	// Settings Configuration options for the target index.
	Settings map[string]json.RawMessage `json:"settings,omitempty"`
}

Request holds the request body struct for the package clone

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/clone/IndicesCloneRequest.ts#L27-L75

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       bool   `json:"acknowledged"`
	Index              string `json:"index"`
	ShardsAcknowledged bool   `json:"shards_acknowledged"`
}

Response holds the response body struct for the package clone

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/indices/clone/IndicesCloneResponse.ts#L22-L28

func NewResponse

func NewResponse() *Response

NewResponse returns a Response