Documentation
¶
Overview ¶
Creates a repository.
Index ¶
- Variables
- type CreateRepository
- func (r CreateRepository) Do(providedCtx 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(providedCtx context.Context) (*http.Response, error)
- 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
- type Request
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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) Header ¶
func (r *CreateRepository) Header(key, value string) *CreateRepository
Header set a key, value pair in the CreateRepository headers map.
func (*CreateRepository) HttpRequest ¶
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 ¶ added in v8.7.0
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) 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
Source Files