listdanglingindices

Documentation

Overview

Returns all dangling indices.

Index

• Variables
• type ListDanglingIndices
  • func New(tp elastictransport.Interface) *ListDanglingIndices
  • func (r ListDanglingIndices) Do(ctx context.Context) (*Response, error)
  • func (r *ListDanglingIndices) Header(key, value string) *ListDanglingIndices
  • func (r *ListDanglingIndices) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ListDanglingIndices) IsSuccess(ctx context.Context) (bool, error)
  • func (r ListDanglingIndices) Perform(ctx context.Context) (*http.Response, error)
• type NewListDanglingIndices
  • func NewListDanglingIndicesFunc(tp elastictransport.Interface) NewListDanglingIndices
• 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 ListDanglingIndices

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

func New

func New(tp elastictransport.Interface) *ListDanglingIndices

Returns all dangling indices.

https://www.elastic.co/guide/en/elasticsearch/reference/master/modules-gateway-dangling-indices.html

func (ListDanglingIndices) Do

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

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

func (*ListDanglingIndices) Header

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

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

func (*ListDanglingIndices) HttpRequest

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

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

func (ListDanglingIndices) IsSuccess

func (r ListDanglingIndices) IsSuccess(ctx context.Context) (bool, error)

IsSuccess allows to run a query with a context and retrieve the result as a boolean. This only exists for endpoints without a request payload and allows for quick control flow.

func (ListDanglingIndices) Perform

func (r ListDanglingIndices) Perform(ctx context.Context) (*http.Response, error)

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

type NewListDanglingIndices

type NewListDanglingIndices func() *ListDanglingIndices

NewListDanglingIndices type alias for index.

func NewListDanglingIndicesFunc

func NewListDanglingIndicesFunc(tp elastictransport.Interface) NewListDanglingIndices

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

type Response

type Response struct {
	DanglingIndices []types.DanglingIndex `json:"dangling_indices"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response