remoteinfo

Documentation

Overview

Returns the information about configured remote clusters.

Index

• Variables
• type NewRemoteInfo
  • func NewRemoteInfoFunc(tp elastictransport.Interface) NewRemoteInfo
• type RemoteInfo
  • func New(tp elastictransport.Interface) *RemoteInfo
  • func (r RemoteInfo) Do(ctx context.Context) (Response, error)
  • func (r *RemoteInfo) Header(key, value string) *RemoteInfo
  • func (r *RemoteInfo) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r RemoteInfo) IsSuccess(ctx context.Context) (bool, error)
  • func (r RemoteInfo) Perform(ctx context.Context) (*http.Response, error)
• 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

Returns the information about configured remote clusters.

https://www.elastic.co/guide/en/elasticsearch/reference/{branch}/cluster-remote-info.html

func (RemoteInfo) Do

func (r RemoteInfo) Do(ctx context.Context) (Response, error)

Do runs the request through the transport, handle the response and returns a remoteinfo.Response

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

func (r RemoteInfo) IsSuccess(ctx 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(ctx context.Context) (*http.Response, error)

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

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