clone

package

v8.13.1 Latest Latest Go to latest Published: Apr 11, 2024 License: Apache-2.0 Imports: 11 Imported by: 3

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/elastic/go-elasticsearch

Links

Open Source Insights

Documentation ¶

Overview ¶

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

Index ¶

Variables
type Clone
- func New(tp elastictransport.Interface) *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

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

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

func (r *Clone) Indices(indices string) *Clone

API name: indices

func (*Clone) MasterTimeout ¶

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

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

func (Clone) Perform ¶ added in v8.7.0

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) Timeout ¶

func (r *Clone) Timeout(duration 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/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/snapshot/clone/SnapshotCloneRequest.ts#L24-L42

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

type Response ¶ added in v8.7.0

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package clone

https://github.com/elastic/elasticsearch-specification/blob/5bf86339cd4bda77d07f6eaa6789b72f9c0279b1/specification/snapshot/clone/SnapshotCloneResponse.ts#L22-L24

func NewResponse ¶ added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL