Documentation
¶
Overview ¶
Returns settings for one or more indices.
Index ¶
- Variables
- type GetSettings
- func (r *GetSettings) AllowNoIndices(allownoindices bool) *GetSettings
- func (r GetSettings) Do(providedCtx context.Context) (Response, error)
- func (r *GetSettings) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetSettings
- func (r *GetSettings) FlatSettings(flatsettings bool) *GetSettings
- func (r *GetSettings) Header(key, value string) *GetSettings
- func (r *GetSettings) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetSettings) IgnoreUnavailable(ignoreunavailable bool) *GetSettings
- func (r *GetSettings) IncludeDefaults(includedefaults bool) *GetSettings
- func (r *GetSettings) Index(index string) *GetSettings
- func (r GetSettings) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetSettings) Local(local bool) *GetSettings
- func (r *GetSettings) MasterTimeout(duration string) *GetSettings
- func (r *GetSettings) Name(name string) *GetSettings
- func (r GetSettings) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetSettings
- 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 GetSettings ¶
type GetSettings struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetSettings
Returns settings for one or more indices.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-get-settings.html
func (*GetSettings) AllowNoIndices ¶
func (r *GetSettings) AllowNoIndices(allownoindices bool) *GetSettings
AllowNoIndices If `false`, the request returns an error if any wildcard expression, index alias, or `_all` value targets only missing or closed indices. This behavior applies even if the request targets other open indices. For example, a request targeting `foo*,bar*` returns an error if an index starts with foo but no index starts with `bar`. API name: allow_no_indices
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) ExpandWildcards ¶
func (r *GetSettings) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetSettings
ExpandWildcards Type of index that wildcard patterns can match. If the request can target data streams, this argument determines whether wildcard expressions match hidden data streams. Supports comma-separated values, such as `open,hidden`. API name: expand_wildcards
func (*GetSettings) FlatSettings ¶
func (r *GetSettings) FlatSettings(flatsettings bool) *GetSettings
FlatSettings If `true`, returns settings in flat format. 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) IgnoreUnavailable ¶
func (r *GetSettings) IgnoreUnavailable(ignoreunavailable bool) *GetSettings
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*GetSettings) IncludeDefaults ¶
func (r *GetSettings) IncludeDefaults(includedefaults bool) *GetSettings
IncludeDefaults If `true`, return all default settings in the response. API name: include_defaults
func (*GetSettings) Index ¶
func (r *GetSettings) Index(index string) *GetSettings
Index Comma-separated list of data streams, indices, and aliases used to limit the request. Supports wildcards (`*`). To target all data streams and indices, omit this parameter or use `*` or `_all`. API Name: index
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) Local ¶
func (r *GetSettings) Local(local bool) *GetSettings
Local If `true`, the request retrieves information from the local node only. If `false`, information is retrieved from the master node. API name: local
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) Name ¶
func (r *GetSettings) Name(name string) *GetSettings
Name Comma-separated list or wildcard expression of settings to retrieve. API Name: name
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 ¶ added in v8.7.0
type Response map[string]types.IndexState
Source Files