invalidateapikey

Documentation

Overview

Invalidates one or more API keys.

Index

• Variables
• type InvalidateApiKey
  • func New(tp elastictransport.Interface) *InvalidateApiKey
  • func (r InvalidateApiKey) Do(ctx context.Context) (*http.Response, error)
  • func (r *InvalidateApiKey) Header(key, value string) *InvalidateApiKey
  • func (r *InvalidateApiKey) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *InvalidateApiKey) Raw(raw json.RawMessage) *InvalidateApiKey
  • func (r *InvalidateApiKey) Request(req *Request) *InvalidateApiKey
• type NewInvalidateApiKey
  • func NewInvalidateApiKeyFunc(tp elastictransport.Interface) NewInvalidateApiKey
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Id(id types.Id) *RequestBuilder
  • func (rb *RequestBuilder) Ids(ids ...types.Id) *RequestBuilder
  • func (rb *RequestBuilder) Name(name types.Name) *RequestBuilder
  • func (rb *RequestBuilder) Owner(owner bool) *RequestBuilder
  • func (rb *RequestBuilder) RealmName(realmname string) *RequestBuilder
  • func (rb *RequestBuilder) Username(username types.Username) *RequestBuilder

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 InvalidateApiKey

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

func New

func New(tp elastictransport.Interface) *InvalidateApiKey

Invalidates one or more API keys.

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

func (InvalidateApiKey) Do

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

Do runs the http.Request through the provided transport.

func (*InvalidateApiKey) Header

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

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

func (*InvalidateApiKey) HttpRequest

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

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

func (*InvalidateApiKey) Raw

func (r *InvalidateApiKey) Raw(raw json.RawMessage) *InvalidateApiKey

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*InvalidateApiKey) Request

func (r *InvalidateApiKey) Request(req *Request) *InvalidateApiKey

Request allows to set the request property with the appropriate payload.

type NewInvalidateApiKey

type NewInvalidateApiKey func() *InvalidateApiKey

NewInvalidateApiKey type alias for index.

func NewInvalidateApiKeyFunc

func NewInvalidateApiKeyFunc(tp elastictransport.Interface) NewInvalidateApiKey

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

type Request

type Request struct {
	Id *types.Id `json:"id,omitempty"`

	Ids []types.Id `json:"ids,omitempty"`

	Name *types.Name `json:"name,omitempty"`

	Owner *bool `json:"owner,omitempty"`

	RealmName *string `json:"realm_name,omitempty"`

	Username *types.Username `json:"username,omitempty"`
}

Request holds the request body struct for the package invalidateapikey

https://github.com/elastic/elasticsearch-specification/blob/1b56d7e58f5c59f05d1641c6d6a8117c5e01d741/specification/security/invalidate_api_key/SecurityInvalidateApiKeyRequest.ts#L23-L37

type RequestBuilder

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

RequestBuilder is the builder API for the invalidateapikey.Request

func NewRequestBuilder

func NewRequestBuilder() *RequestBuilder

NewRequest returns a RequestBuilder which can be chained and built to retrieve a RequestBuilder

func (*RequestBuilder) Build

func (rb *RequestBuilder) Build() *Request

Build finalize the chain and returns the Request struct.

func (*RequestBuilder) FromJSON

func (rb *RequestBuilder) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Id

func (rb *RequestBuilder) Id(id types.Id) *RequestBuilder

func (*RequestBuilder) Ids

func (rb *RequestBuilder) Ids(ids ...types.Id) *RequestBuilder

func (*RequestBuilder) Name

func (rb *RequestBuilder) Name(name types.Name) *RequestBuilder

func (*RequestBuilder) Owner

func (rb *RequestBuilder) Owner(owner bool) *RequestBuilder

func (*RequestBuilder) RealmName

func (rb *RequestBuilder) RealmName(realmname string) *RequestBuilder

func (*RequestBuilder) Username

func (rb *RequestBuilder) Username(username types.Username) *RequestBuilder