queryapikeys

Documentation

Overview

Retrieves information for API keys using a subset of query DSL

Index

• Variables
• type NewQueryApiKeys
  • func NewQueryApiKeysFunc(tp elastictransport.Interface) NewQueryApiKeys
• type QueryApiKeys
  • func New(tp elastictransport.Interface) *QueryApiKeys
  • func (r QueryApiKeys) Do(ctx context.Context) (*http.Response, error)
  • func (r *QueryApiKeys) Header(key, value string) *QueryApiKeys
  • func (r *QueryApiKeys) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *QueryApiKeys) Raw(raw json.RawMessage) *QueryApiKeys
  • func (r *QueryApiKeys) Request(req *Request) *QueryApiKeys
• type Request
• type RequestBuilder
  • func NewRequestBuilder() *RequestBuilder
  • func (rb *RequestBuilder) Build() *Request
  • func (rb *RequestBuilder) From(from int) *RequestBuilder
  • func (rb *RequestBuilder) FromJSON(data string) (*Request, error)
  • func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder
  • func (rb *RequestBuilder) SearchAfter(searchafter *types.SortResultsBuilder) *RequestBuilder
  • func (rb *RequestBuilder) Size(size int) *RequestBuilder
  • func (rb *RequestBuilder) Sort(sort *types.SortBuilder) *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 NewQueryApiKeys

type NewQueryApiKeys func() *QueryApiKeys

NewQueryApiKeys type alias for index.

func NewQueryApiKeysFunc

func NewQueryApiKeysFunc(tp elastictransport.Interface) NewQueryApiKeys

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

type QueryApiKeys

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

func New

func New(tp elastictransport.Interface) *QueryApiKeys

Retrieves information for API keys using a subset of query DSL

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

func (QueryApiKeys) Do

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

Do runs the http.Request through the provided transport.

func (*QueryApiKeys) Header

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

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

func (*QueryApiKeys) HttpRequest

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

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

func (*QueryApiKeys) Raw

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

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

func (*QueryApiKeys) Request

func (r *QueryApiKeys) Request(req *Request) *QueryApiKeys

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

type Request

type Request struct {

	// From Starting document offset. By default, you cannot page through more than
	// 10,000
	// hits using the from and size parameters. To page through more hits, use the
	// search_after parameter.
	From *int `json:"from,omitempty"`

	// Query A query to filter which API keys to return.
	// The query supports a subset of query types, including match_all, bool, term,
	// terms, ids, prefix, wildcard, and range.
	// You can query all public information associated with an API key
	Query *types.QueryContainer `json:"query,omitempty"`

	SearchAfter *types.SortResults `json:"search_after,omitempty"`

	// Size The number of hits to return. By default, you cannot page through more
	// than 10,000 hits using the from and size parameters. To page through more
	// hits, use the search_after parameter.
	Size *int `json:"size,omitempty"`

	Sort *types.Sort `json:"sort,omitempty"`
}

Request holds the request body struct for the package queryapikeys

https://github.com/elastic/elasticsearch-specification/blob/4316fc1aa18bb04678b156f23b22c9d3f996f9c9/specification/security/query_api_keys/QueryApiKeysRequest.ts#L25-L56

type RequestBuilder

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

RequestBuilder is the builder API for the queryapikeys.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) From

func (rb *RequestBuilder) From(from int) *RequestBuilder

func (*RequestBuilder) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

func (*RequestBuilder) Query

func (rb *RequestBuilder) Query(query *types.QueryContainerBuilder) *RequestBuilder

func (*RequestBuilder) SearchAfter

func (rb *RequestBuilder) SearchAfter(searchafter *types.SortResultsBuilder) *RequestBuilder

func (*RequestBuilder) Size

func (rb *RequestBuilder) Size(size int) *RequestBuilder

func (*RequestBuilder) Sort

func (rb *RequestBuilder) Sort(sort *types.SortBuilder) *RequestBuilder