getsettings

Documentation

Overview

Get security index settings.

Get the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:

* `index.auto_expand_replicas` * `index.number_of_replicas`

Index

• Variables
• type GetSettings
  • func New(tp elastictransport.Interface) *GetSettings
  • func (r GetSettings) Do(providedCtx context.Context) (*Response, error)
  • func (r *GetSettings) ErrorTrace(errortrace bool) *GetSettings
  • func (r *GetSettings) FilterPath(filterpaths ...string) *GetSettings
  • func (r *GetSettings) Header(key, value string) *GetSettings
  • func (r *GetSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetSettings) Human(human bool) *GetSettings
  • func (r GetSettings) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r *GetSettings) MasterTimeout(duration string) *GetSettings
  • func (r GetSettings) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *GetSettings) Pretty(pretty bool) *GetSettings
• 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

Get security index settings.

Get the user-configurable settings for the security internal index (`.security` and associated indices). Only a subset of the index settings — those that are user-configurable—will be shown. This includes:

* `index.auto_expand_replicas` * `index.number_of_replicas`

https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-security-get-settings

func (GetSettings) Do

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

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

func (*GetSettings) ErrorTrace

func (r *GetSettings) ErrorTrace(errortrace bool) *GetSettings

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*GetSettings) FilterPath

func (r *GetSettings) FilterPath(filterpaths ...string) *GetSettings

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *GetSettings) Human(human bool) *GetSettings

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"exists_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (GetSettings) IsSuccess

func (r GetSettings) IsSuccess(providedCtx 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(duration string) *GetSettings

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (GetSettings) Perform

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

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

func (*GetSettings) Pretty

func (r *GetSettings) Pretty(pretty bool) *GetSettings

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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 struct {

	// Security Settings for the index used for most security configuration, including native
	// realm users and roles configured with the API.
	Security types.SecuritySettings `json:"security"`
	// SecurityProfile Settings for the index used to store profile information.
	SecurityProfile types.SecuritySettings `json:"security-profile"`
	// SecurityTokens Settings for the index used to store tokens.
	SecurityTokens types.SecuritySettings `json:"security-tokens"`
}

Response holds the response body struct for the package getsettings

https://github.com/elastic/elasticsearch-specification/blob/907d11a72a6bfd37b777d526880c56202889609e/specification/security/get_settings/SecurityGetSettingsResponse.ts#L21-L36

func NewResponse

func NewResponse() *Response

NewResponse returns a Response