Documentation
¶
Overview ¶
Returns an alias.
Index ¶
- Variables
- type GetAlias
- func (r *GetAlias) AllowNoIndices(allownoindices bool) *GetAlias
- func (r GetAlias) Do(providedCtx context.Context) (Response, error)
- func (r *GetAlias) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetAlias
- func (r *GetAlias) Header(key, value string) *GetAlias
- func (r *GetAlias) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *GetAlias) IgnoreUnavailable(ignoreunavailable bool) *GetAlias
- func (r *GetAlias) Index(index string) *GetAlias
- func (r GetAlias) IsSuccess(providedCtx context.Context) (bool, error)
- func (r *GetAlias) Local(local bool) *GetAlias
- func (r *GetAlias) Name(name string) *GetAlias
- func (r GetAlias) Perform(providedCtx context.Context) (*http.Response, error)
- type NewGetAlias
- 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 GetAlias ¶
type GetAlias struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *GetAlias
Returns an alias.
https://www.elastic.co/guide/en/elasticsearch/reference/current/indices-aliases.html
func (*GetAlias) AllowNoIndices ¶
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. API name: allow_no_indices
func (GetAlias) Do ¶
Do runs the request through the transport, handle the response and returns a getalias.Response
func (*GetAlias) ExpandWildcards ¶
func (r *GetAlias) ExpandWildcards(expandwildcards ...expandwildcard.ExpandWildcard) *GetAlias
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`. Valid values are: `all`, `open`, `closed`, `hidden`, `none`. API name: expand_wildcards
func (*GetAlias) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*GetAlias) IgnoreUnavailable ¶
IgnoreUnavailable If `false`, the request returns an error if it targets a missing or closed index. API name: ignore_unavailable
func (*GetAlias) Index ¶
Index Comma-separated list of data streams or indices 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 (GetAlias) IsSuccess ¶
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 (*GetAlias) Local ¶
Local If `true`, the request retrieves information from the local node only. API name: local
type NewGetAlias ¶
type NewGetAlias func() *GetAlias
NewGetAlias type alias for index.
func NewGetAliasFunc ¶
func NewGetAliasFunc(tp elastictransport.Interface) NewGetAlias
NewGetAliasFunc returns a new instance of GetAlias 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.IndexAliases
Source Files