createrepository

Documentation

Overview

Creates a repository.

Index

• Variables
• type CreateRepository
  • func New(tp elastictransport.Interface) *CreateRepository
  • func (r CreateRepository) Do(ctx context.Context) (*Response, error)
  • func (r *CreateRepository) Header(key, value string) *CreateRepository
  • func (r *CreateRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CreateRepository) MasterTimeout(duration string) *CreateRepository
  • func (r CreateRepository) Perform(ctx context.Context) (*http.Response, error)
  • func (r *CreateRepository) Raw(raw io.Reader) *CreateRepository
  • func (r *CreateRepository) Repository(repository string) *CreateRepository
  • func (r *CreateRepository) Request(req *Request) *CreateRepository
  • func (r *CreateRepository) Settings(settings *types.RepositorySettings) *CreateRepository
  • func (r *CreateRepository) Timeout(duration string) *CreateRepository
  • func (r *CreateRepository) Type(type_ string) *CreateRepository
  • func (r *CreateRepository) Verify(verify bool) *CreateRepository
• type NewCreateRepository
  • func NewCreateRepositoryFunc(tp elastictransport.Interface) NewCreateRepository
• 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 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/master/modules-snapshots.html

func (CreateRepository) Do

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

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

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) 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(ctx context.Context) (*http.Response, error)

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

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) Repository

func (r *CreateRepository) Repository(repository string) *CreateRepository

Repository A repository name API Name: repository

func (*CreateRepository) Request

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

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

func (*CreateRepository) Settings

func (r *CreateRepository) Settings(settings *types.RepositorySettings) *CreateRepository

API name: settings

func (*CreateRepository) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*CreateRepository) Type

func (r *CreateRepository) Type(type_ string) *CreateRepository

API name: type

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 struct {
	Repository *types.Repository        `json:"repository,omitempty"`
	Settings   types.RepositorySettings `json:"settings"`
	Type       string                   `json:"type"`
}

Request holds the request body struct for the package createrepository

https://github.com/elastic/elasticsearch-specification/blob/656080dee792f93a849cd7fbf566f528f858a5ea/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L28-L48

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