Documentation ¶
Overview ¶
Returns cluster settings.
Index ¶
- Variables
- type GetSettings
- func (r GetSettings) Do(ctx context.Context) (*http.Response, error)
- 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) IncludeDefaults(b bool) *GetSettings
- func (r GetSettings) IsSuccess(ctx context.Context) (bool, error)
- func (r *GetSettings) MasterTimeout(value string) *GetSettings
- func (r *GetSettings) Timeout(value string) *GetSettings
- type NewGetSettings
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 GetSettings ¶
type GetSettings struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetSettings
Returns cluster settings.
https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-get-settings.html
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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetSettings) IncludeDefaults ¶
func (r *GetSettings) IncludeDefaults(b bool) *GetSettings
IncludeDefaults Whether to return all default clusters setting. API name: include_defaults
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) MasterTimeout ¶
func (r *GetSettings) MasterTimeout(value string) *GetSettings
MasterTimeout Explicit operation timeout for connection to master node API name: master_timeout
func (*GetSettings) Timeout ¶
func (r *GetSettings) Timeout(value string) *GetSettings
Timeout Explicit operation timeout API name: timeout
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.