remoteinfo

Documentation

Overview

The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias.

Index

• Variables
• type NewRemoteInfo
  • func NewRemoteInfoFunc(tp elastictransport.Interface) NewRemoteInfo
• type RemoteInfo
  • func New(tp elastictransport.Interface) *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
  • func NewResponse() Response
  • func (r Response) UnmarshalJSON(data []byte) error

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

The cluster remote info API allows you to retrieve all of the configured remote cluster information. It returns connection and endpoint information keyed by the configured remote cluster alias.

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

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

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

func (r *RemoteInfo) HttpRequest(ctx context.Context) (*http.Request, error)

HttpRequest returns the http.Request object built from the given parameters.

func (*RemoteInfo) Human

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

func (r RemoteInfo) Perform(providedCtx context.Context) (*http.Response, error)

Perform runs the http.Request through the provided transport and returns an http.Response.

func (*RemoteInfo) Pretty

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

type Response map[string]types.ClusterRemoteInfo

func NewResponse

func NewResponse() Response

NewResponse returns a Response

func (Response) UnmarshalJSON

func (r Response) UnmarshalJSON(data []byte) error