createrepository

Documentation

Overview

Creates a repository.

Index

• Variables
• type CreateRepository
  • func New(tp elastictransport.Interface) *CreateRepository
  • func (r CreateRepository) Do(ctx context.Context) (*http.Response, error)
  • func (r *CreateRepository) Header(key, value string) *CreateRepository
  • func (r *CreateRepository) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *CreateRepository) MasterTimeout(value string) *CreateRepository
  • func (r *CreateRepository) Raw(raw json.RawMessage) *CreateRepository
  • func (r *CreateRepository) Repository(v string) *CreateRepository
  • func (r *CreateRepository) Request(req *Request) *CreateRepository
  • func (r *CreateRepository) Timeout(value string) *CreateRepository
  • func (r *CreateRepository) Verify(b bool) *CreateRepository
• type NewCreateRepository
  • func NewCreateRepositoryFunc(tp elastictransport.Interface) NewCreateRepository
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Repository(repository *types.RepositoryBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Settings(settings *types.RepositorySettingsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Type_(type_ string) *RequestBuilder

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

Do runs the http.Request through the provided transport.

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(value string) *CreateRepository

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

func (*CreateRepository) Raw

func (r *CreateRepository) Raw(raw json.RawMessage) *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(v 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) Timeout

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

Timeout Explicit operation timeout API name: timeout

func (*CreateRepository) Verify

func (r *CreateRepository) Verify(b 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/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/snapshot/create_repository/SnapshotCreateRepositoryRequest.ts#L28-L49

type RequestBuilder

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

RequestBuilder is the builder API for the createrepository.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Repository

func (rb *RequestBuilder) Repository(repository *types.RepositoryBuilder) *RequestBuilder

func (*RequestBuilder) Settings

func (rb *RequestBuilder) Settings(settings *types.RepositorySettingsBuilder) *RequestBuilder

func (*RequestBuilder) Type_

func (rb *RequestBuilder) Type_(type_ string) *RequestBuilder