reloadsecuresettings

Documentation

Overview

Reloads secure settings.

Index

• Variables
• type NewReloadSecureSettings
  • func NewReloadSecureSettingsFunc(tp elastictransport.Interface) NewReloadSecureSettings
• type ReloadSecureSettings
  • func New(tp elastictransport.Interface) *ReloadSecureSettings
  • func (r ReloadSecureSettings) Do(ctx context.Context) (*http.Response, error)
  • func (r *ReloadSecureSettings) Header(key, value string) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *ReloadSecureSettings) NodeId(v string) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Raw(raw json.RawMessage) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Request(req *Request) *ReloadSecureSettings
  • func (r *ReloadSecureSettings) Timeout(value string) *ReloadSecureSettings
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) SecureSettingsPassword(securesettingspassword types.Password) *RequestBuilder

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 secure settings.

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

func (ReloadSecureSettings) Do

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

Do runs the http.Request through the provided transport.

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

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

NodeId A comma-separated list of node IDs to span the reload/reinit call. Should stay empty because reloading usually involves all cluster nodes. API Name: nodeid

func (*ReloadSecureSettings) Raw

func (r *ReloadSecureSettings) Raw(raw json.RawMessage) *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) Timeout

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

Timeout Explicit operation timeout API name: timeout

type Request

type Request struct {
	SecureSettingsPassword *types.Password `json:"secure_settings_password,omitempty"`
}

Request holds the request body struct for the package reloadsecuresettings

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/nodes/reload_secure_settings/ReloadSecureSettingsRequest.ts#L24-L39

type RequestBuilder

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

RequestBuilder is the builder API for the reloadsecuresettings.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) SecureSettingsPassword

func (rb *RequestBuilder) SecureSettingsPassword(securesettingspassword types.Password) *RequestBuilder