createrepository

Documentation

Overview

Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used.

Index

• Variables
• type CreateRepository
  • func New(tp elastictransport.Interface) *CreateRepository
  • func (r CreateRepository) Do(providedCtx context.Context) (*Response, error)
  • func (r *CreateRepository) ErrorTrace(errortrace bool) *CreateRepository
  • func (r *CreateRepository) FilterPath(filterpaths ...string) *CreateRepository
  • func (r *CreateRepository) Header(key, value string) *CreateRepository
  • func (r *CreateRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CreateRepository) Human(human bool) *CreateRepository
  • func (r *CreateRepository) MasterTimeout(duration string) *CreateRepository
  • func (r CreateRepository) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *CreateRepository) Pretty(pretty bool) *CreateRepository
  • func (r *CreateRepository) Raw(raw io.Reader) *CreateRepository
  • func (r *CreateRepository) Request(req *Request) *CreateRepository
  • func (r *CreateRepository) Timeout(duration string) *CreateRepository
  • func (r *CreateRepository) Verify(verify bool) *CreateRepository
• type NewCreateRepository
  • func NewCreateRepositoryFunc(tp elastictransport.Interface) NewCreateRepository
• type Request
• 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 CreateRepository

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

func New

func New(tp elastictransport.Interface) *CreateRepository

Create or update a snapshot repository. IMPORTANT: If you are migrating searchable snapshots, the repository name must be identical in the source and destination clusters. To register a snapshot repository, the cluster's global metadata must be writeable. Ensure there are no cluster blocks (for example, `cluster.blocks.read_only` and `clsuter.blocks.read_only_allow_delete` settings) that prevent write access.

Several options for this API can be specified using a query parameter or a request body parameter. If both parameters are specified, only the query parameter is used.

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-create-repository

func (CreateRepository) Do

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

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

func (*CreateRepository) ErrorTrace

func (r *CreateRepository) ErrorTrace(errortrace bool) *CreateRepository

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*CreateRepository) FilterPath

func (r *CreateRepository) FilterPath(filterpaths ...string) *CreateRepository

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*CreateRepository) Header

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

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

func (*CreateRepository) HttpRequest

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

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

func (*CreateRepository) Human

func (r *CreateRepository) Human(human bool) *CreateRepository

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*CreateRepository) MasterTimeout

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

MasterTimeout The period to wait for the master node. If the master node is not available before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout

func (CreateRepository) Perform

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

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

func (*CreateRepository) Pretty

func (r *CreateRepository) Pretty(pretty bool) *CreateRepository

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*CreateRepository) Raw

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

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

func (*CreateRepository) Request

func (r *CreateRepository) Request(req *Request) *CreateRepository

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

func (*CreateRepository) Timeout

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

Timeout The period to wait for a response from all relevant nodes in the cluster after updating the cluster metadata. If no response is received before the timeout expires, the cluster metadata update still applies but the response will indicate that it was not completely acknowledged. To indicate that the request should never timeout, set it to `-1`. API name: timeout

func (*CreateRepository) Verify

func (r *CreateRepository) Verify(verify bool) *CreateRepository

Verify If `true`, the request verifies the repository is functional on all master and data nodes in the cluster. If `false`, this verification is skipped. You can also perform this verification with the verify snapshot repository API. API name: verify

type NewCreateRepository

type NewCreateRepository func(repository string) *CreateRepository

NewCreateRepository type alias for index.

func NewCreateRepositoryFunc

func NewCreateRepositoryFunc(tp elastictransport.Interface) NewCreateRepository

NewCreateRepositoryFunc returns a new instance of CreateRepository with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Request

type Request = types.Repository

Request holds the request body struct for the package createrepository

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L79

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"`
}

Response holds the response body struct for the package createrepository

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/snapshot/create_repository/SnapshotCreateRepositoryResponse.ts#L22-L25

func NewResponse

func NewResponse() *Response

NewResponse returns a Response