Documentation
¶
Overview ¶
Reloads secure settings.
Index ¶
- Variables
- type NewReloadSecureSettings
- type ReloadSecureSettings
- func (r ReloadSecureSettings) Do(providedCtx context.Context) (*Response, error)
- func (r *ReloadSecureSettings) Header(key, value string) *ReloadSecureSettings
- func (r *ReloadSecureSettings) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *ReloadSecureSettings) NodeId(nodeid string) *ReloadSecureSettings
- func (r ReloadSecureSettings) Perform(providedCtx context.Context) (*http.Response, error)
- 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
- type Response
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 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 (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) Header ¶
func (r *ReloadSecureSettings) Header(key, value string) *ReloadSecureSettings
Header set a key, value pair in the ReloadSecureSettings headers map.
func (*ReloadSecureSettings) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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 ¶ added in v8.9.0
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
type Response ¶ added in v8.7.0
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
Source Files