getsettings

Documentation

Overview

Returns settings for one or more indices.

Index

• Variables
• type GetSettings
  • func New(tp elastictransport.Interface) *GetSettings
  • func (r *GetSettings) AllowNoIndices(b bool) *GetSettings
  • func (r GetSettings) Do(ctx context.Context) (Response, error)
  • func (r *GetSettings) ExpandWildcards(v string) *GetSettings
  • func (r *GetSettings) FlatSettings(b bool) *GetSettings
  • func (r *GetSettings) Header(key, value string) *GetSettings
  • func (r *GetSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetSettings) IgnoreUnavailable(b bool) *GetSettings
  • func (r *GetSettings) IncludeDefaults(b bool) *GetSettings
  • func (r *GetSettings) Index(v string) *GetSettings
  • func (r GetSettings) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetSettings) Local(b bool) *GetSettings
  • func (r *GetSettings) MasterTimeout(v string) *GetSettings
  • func (r *GetSettings) Name(v string) *GetSettings
  • func (r GetSettings) Perform(ctx context.Context) (*http.Response, error)
• type NewGetSettings
  • func NewGetSettingsFunc(tp elastictransport.Interface) NewGetSettings
• 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 GetSettings

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

func New

func New(tp elastictransport.Interface) *GetSettings

Returns settings for one or more indices.

https://www.elastic.co/guide/en/elasticsearch/reference/master/indices-get-settings.html

func (*GetSettings) AllowNoIndices

func (r *GetSettings) AllowNoIndices(b bool) *GetSettings

AllowNoIndices Whether to ignore if a wildcard indices expression resolves into no concrete indices. (This includes `_all` string or when no indices have been specified) API name: allow_no_indices

func (GetSettings) Do

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

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

func (*GetSettings) ExpandWildcards

func (r *GetSettings) ExpandWildcards(v string) *GetSettings

ExpandWildcards Whether to expand wildcard expression to concrete indices that are open, closed or both. API name: expand_wildcards

func (*GetSettings) FlatSettings

func (r *GetSettings) FlatSettings(b bool) *GetSettings

FlatSettings Return settings in flat format (default: false) API name: flat_settings

func (*GetSettings) Header

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

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

func (*GetSettings) HttpRequest

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

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

func (*GetSettings) IgnoreUnavailable

func (r *GetSettings) IgnoreUnavailable(b bool) *GetSettings

IgnoreUnavailable Whether specified concrete indices should be ignored when unavailable (missing or closed) API name: ignore_unavailable

func (*GetSettings) IncludeDefaults

func (r *GetSettings) IncludeDefaults(b bool) *GetSettings

IncludeDefaults Whether to return all default setting for each of the indices. API name: include_defaults

func (*GetSettings) Index

func (r *GetSettings) Index(v string) *GetSettings

Index A comma-separated list of index names; use `_all` or empty string to perform the operation on all indices API Name: index

func (GetSettings) IsSuccess

func (r GetSettings) 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 (*GetSettings) Local

func (r *GetSettings) Local(b bool) *GetSettings

Local Return local information, do not retrieve the state from master node (default: false) API name: local

func (*GetSettings) MasterTimeout

func (r *GetSettings) MasterTimeout(v string) *GetSettings

MasterTimeout Specify timeout for connection to master API name: master_timeout

func (*GetSettings) Name

func (r *GetSettings) Name(v string) *GetSettings

Name The name of the settings that should be included API Name: name

func (GetSettings) Perform

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

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

type NewGetSettings

type NewGetSettings func() *GetSettings

NewGetSettings type alias for index.

func NewGetSettingsFunc

func NewGetSettingsFunc(tp elastictransport.Interface) NewGetSettings

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

type Response

type Response map[string]types.IndexState

func NewResponse

func NewResponse() Response

NewResponse returns a Response