certificates

Documentation

Overview

Retrieves information about the X.509 certificates used to encrypt communications in the cluster.

Index

• Variables
• type Certificates
  • func New(tp elastictransport.Interface) *Certificates
  • func (r Certificates) Do(ctx context.Context) (Response, error)
  • func (r *Certificates) Header(key, value string) *Certificates
  • func (r *Certificates) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Certificates) IsSuccess(ctx context.Context) (bool, error)
  • func (r Certificates) Perform(ctx context.Context) (*http.Response, error)
• type NewCertificates
  • func NewCertificatesFunc(tp elastictransport.Interface) NewCertificates
• type Response
  • func NewResponse() Response

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 Certificates

type Certificates struct {
	// contains filtered or unexported fields
}

func New

func New(tp elastictransport.Interface) *Certificates

Retrieves information about the X.509 certificates used to encrypt communications in the cluster.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-ssl.html

func (Certificates) Do

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

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

func (*Certificates) Header

func (r *Certificates) Header(key, value string) *Certificates

Header set a key, value pair in the Certificates headers map.

func (*Certificates) HttpRequest

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

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

func (Certificates) IsSuccess

func (r Certificates) 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 (Certificates) Perform

func (r Certificates) Perform(ctx context.Context) (*http.Response, error)

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

type NewCertificates

type NewCertificates func() *Certificates

NewCertificates type alias for index.

func NewCertificatesFunc

func NewCertificatesFunc(tp elastictransport.Interface) NewCertificates

NewCertificatesFunc returns a new instance of Certificates with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type Response

type Response []types.CertificateInformation

func NewResponse

func NewResponse() Response

NewResponse returns a Response