createrepository

Documentation

Overview

Creates a repository.

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

Creates a repository.

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

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 `"eixsts_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 Explicit operation timeout for connection to master node 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 Explicit operation timeout API name: timeout

func (*CreateRepository) Verify

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

Verify Whether to verify the repository after creation 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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L25-L42

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/2f823ff6fcaa7f3f0f9b990dc90512d8901e5d64/specification/snapshot/create_repository/SnapshotCreateRepositoryResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response