Documentation
¶
Overview ¶
Get remote cluster information.
Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.
> info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the `/_resolve/cluster` endpoint.
Index ¶
- Variables
- type NewRemoteInfo
- type RemoteInfo
- func (r RemoteInfo) Do(providedCtx context.Context) (Response, error)
- func (r *RemoteInfo) ErrorTrace(errortrace bool) *RemoteInfo
- func (r *RemoteInfo) FilterPath(filterpaths ...string) *RemoteInfo
- func (r *RemoteInfo) Header(key, value string) *RemoteInfo
- func (r *RemoteInfo) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r *RemoteInfo) Human(human bool) *RemoteInfo
- func (r RemoteInfo) IsSuccess(providedCtx context.Context) (bool, error)
- func (r RemoteInfo) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *RemoteInfo) Pretty(pretty bool) *RemoteInfo
- 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 NewRemoteInfo ¶
type NewRemoteInfo func() *RemoteInfo
NewRemoteInfo type alias for index.
func NewRemoteInfoFunc ¶
func NewRemoteInfoFunc(tp elastictransport.Interface) NewRemoteInfo
NewRemoteInfoFunc returns a new instance of RemoteInfo with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.
type RemoteInfo ¶
type RemoteInfo struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *RemoteInfo
Get remote cluster information.
Get information about configured remote clusters. The API returns connection and endpoint information keyed by the configured remote cluster alias.
> info > This API returns information that reflects current state on the local cluster. > The `connected` field does not necessarily reflect whether a remote cluster is down or unavailable, only whether there is currently an open connection to it. > Elasticsearch does not spontaneously try to reconnect to a disconnected remote cluster. > To trigger a reconnection, attempt a cross-cluster search, ES|QL cross-cluster search, or try the `/_resolve/cluster` endpoint.
https://www.elastic.co/guide/en/elasticsearch/reference/current/cluster-remote-info.html
func (RemoteInfo) Do ¶
func (r RemoteInfo) Do(providedCtx context.Context) (Response, error)
Do runs the request through the transport, handle the response and returns a remoteinfo.Response
func (*RemoteInfo) ErrorTrace ¶ added in v8.14.0
func (r *RemoteInfo) ErrorTrace(errortrace bool) *RemoteInfo
ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace
func (*RemoteInfo) FilterPath ¶ added in v8.14.0
func (r *RemoteInfo) FilterPath(filterpaths ...string) *RemoteInfo
FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path
func (*RemoteInfo) Header ¶
func (r *RemoteInfo) Header(key, value string) *RemoteInfo
Header set a key, value pair in the RemoteInfo headers map.
func (*RemoteInfo) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*RemoteInfo) Human ¶ added in v8.14.0
func (r *RemoteInfo) Human(human bool) *RemoteInfo
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 (RemoteInfo) IsSuccess ¶
func (r RemoteInfo) 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 (RemoteInfo) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*RemoteInfo) Pretty ¶ added in v8.14.0
func (r *RemoteInfo) Pretty(pretty bool) *RemoteInfo
Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty
type Response ¶ added in v8.7.0
type Response map[string]types.ClusterRemoteInfo
Source Files
