reloadsecuresettings

Documentation

Overview

Reloads the keystore on nodes in the cluster.

Index

• Variables
• type NewReloadSecureSettings
  • func NewReloadSecureSettingsFunc(tp elastictransport.Interface) NewReloadSecureSettings
• type ReloadSecureSettings
  • func New(tp elastictransport.Interface) *ReloadSecureSettings
  • func (r ReloadSecureSettings) Do(providedCtx context.Context) (*Response, error)
  • func (r *ReloadSecureSettings) ErrorTrace(errortrace bool) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) FilterPath(filterpaths ...string) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Header(key, value string) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ReloadSecureSettings) Human(human bool) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) NodeId(nodeid string) *ReloadSecureSettings
  • func (r ReloadSecureSettings) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *ReloadSecureSettings) Pretty(pretty bool) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Raw(raw io.Reader) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Request(req *Request) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) SecureSettingsPassword(password string) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Timeout(duration string) *ReloadSecureSettings
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) error
• type Response
  • func NewResponse() *Response
  • func (s *Response) UnmarshalJSON(data []byte) error

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 NewReloadSecureSettings

type NewReloadSecureSettings func() *ReloadSecureSettings

NewReloadSecureSettings type alias for index.

func NewReloadSecureSettingsFunc

func NewReloadSecureSettingsFunc(tp elastictransport.Interface) NewReloadSecureSettings

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

type ReloadSecureSettings

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

func New

func New(tp elastictransport.Interface) *ReloadSecureSettings

Reloads the keystore on nodes in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/secure-settings.html#reloadable-secure-settings

func (ReloadSecureSettings) Do

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

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

func (*ReloadSecureSettings) ErrorTrace

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

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

func (*ReloadSecureSettings) FilterPath

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

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

func (*ReloadSecureSettings) Header

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

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

func (*ReloadSecureSettings) HttpRequest

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

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

func (*ReloadSecureSettings) Human

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

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_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 (*ReloadSecureSettings) NodeId

func (r *ReloadSecureSettings) NodeId(nodeid string) *ReloadSecureSettings

NodeId The names of particular nodes in the cluster to target. API Name: nodeid

func (ReloadSecureSettings) Perform

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

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

func (*ReloadSecureSettings) Pretty

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

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

func (*ReloadSecureSettings) Raw

func (r *ReloadSecureSettings) Raw(raw io.Reader) *ReloadSecureSettings

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*ReloadSecureSettings) Request

func (r *ReloadSecureSettings) Request(req *Request) *ReloadSecureSettings

Request allows to set the request property with the appropriate payload.

func (*ReloadSecureSettings) SecureSettingsPassword

func (r *ReloadSecureSettings) SecureSettingsPassword(password string) *ReloadSecureSettings

SecureSettingsPassword The password for the Elasticsearch keystore. API name: secure_settings_password

func (*ReloadSecureSettings) Timeout

func (r *ReloadSecureSettings) Timeout(duration string) *ReloadSecureSettings

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

type Request

type Request struct {

	// SecureSettingsPassword The password for the Elasticsearch keystore.
	SecureSettingsPassword *string `json:"secure_settings_password,omitempty"`
}

Request holds the request body struct for the package reloadsecuresettings

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L51

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

type Response

type Response struct {
	ClusterName string `json:"cluster_name"`
	// NodeStats Contains statistics about the number of nodes selected by the request’s node
	// filters.
	NodeStats *types.NodeStatistics             `json:"_nodes,omitempty"`
	Nodes     map[string]types.NodeReloadResult `json:"nodes"`
}

Response holds the response body struct for the package reloadsecuresettings

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/nodes/reload_secure_settings/ReloadSecureSettingsResponse.ts#L30-L32

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

func (*Response) UnmarshalJSON

func (s *Response) UnmarshalJSON(data []byte) error