getapikey

Documentation

Overview

Retrieves information for one or more API keys.

Index

• Variables
• type GetApiKey
  • func New(tp elastictransport.Interface) *GetApiKey
  • func (r GetApiKey) Do(ctx context.Context) (*http.Response, error)
  • func (r *GetApiKey) Header(key, value string) *GetApiKey
  • func (r *GetApiKey) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *GetApiKey) Id(value string) *GetApiKey
  • func (r GetApiKey) IsSuccess(ctx context.Context) (bool, error)
  • func (r *GetApiKey) Name(value string) *GetApiKey
  • func (r *GetApiKey) Owner(b bool) *GetApiKey
  • func (r *GetApiKey) RealmName(value string) *GetApiKey
  • func (r *GetApiKey) Username(value string) *GetApiKey
• type NewGetApiKey
  • func NewGetApiKeyFunc(tp elastictransport.Interface) NewGetApiKey

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 GetApiKey

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

func New

func New(tp elastictransport.Interface) *GetApiKey

Retrieves information for one or more API keys.

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

func (GetApiKey) Do

func (r GetApiKey) Do(ctx context.Context) (*http.Response, error)

Do runs the http.Request through the provided transport.

func (*GetApiKey) Header

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

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

func (*GetApiKey) HttpRequest

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

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

func (*GetApiKey) Id

func (r *GetApiKey) Id(value string) *GetApiKey

Id API key id of the API key to be retrieved API name: id

func (GetApiKey) IsSuccess

func (r GetApiKey) 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 (*GetApiKey) Name

func (r *GetApiKey) Name(value string) *GetApiKey

Name API key name of the API key to be retrieved API name: name

func (*GetApiKey) Owner

func (r *GetApiKey) Owner(b bool) *GetApiKey

Owner flag to query API keys owned by the currently authenticated user API name: owner

func (*GetApiKey) RealmName

func (r *GetApiKey) RealmName(value string) *GetApiKey

RealmName realm name of the user who created this API key to be retrieved API name: realm_name

func (*GetApiKey) Username

func (r *GetApiKey) Username(value string) *GetApiKey

Username user name of the user who created this API key to be retrieved API name: username

type NewGetApiKey

type NewGetApiKey func() *GetApiKey

NewGetApiKey type alias for index.

func NewGetApiKeyFunc

func NewGetApiKeyFunc(tp elastictransport.Interface) NewGetApiKey

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