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(providedCtx context.Context) (*Response, error)
  • func (r *QueryApiKeys) From(from int) *QueryApiKeys
  • func (r *QueryApiKeys) Header(key, value string) *QueryApiKeys
  • func (r *QueryApiKeys) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r QueryApiKeys) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *QueryApiKeys) Query(query *types.Query) *QueryApiKeys
  • func (r *QueryApiKeys) Raw(raw io.Reader) *QueryApiKeys
  • func (r *QueryApiKeys) Request(req *Request) *QueryApiKeys
  • func (r *QueryApiKeys) SearchAfter(sortresults ...types.FieldValue) *QueryApiKeys
  • func (r *QueryApiKeys) Size(size int) *QueryApiKeys
  • func (r *QueryApiKeys) Sort(sorts ...types.SortCombinations) *QueryApiKeys
  • func (r *QueryApiKeys) WithLimitedBy(withlimitedby bool) *QueryApiKeys
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 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(providedCtx context.Context) (*Response, error)

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

func (*QueryApiKeys) From

func (r *QueryApiKeys) From(from int) *QueryApiKeys

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. API name: from

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

func (r QueryApiKeys) Perform(providedCtx context.Context) (*http.Response, error)

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

func (*QueryApiKeys) Query

func (r *QueryApiKeys) Query(query *types.Query) *QueryApiKeys

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. API name: query

func (*QueryApiKeys) Raw

func (r *QueryApiKeys) Raw(raw io.Reader) *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.

func (*QueryApiKeys) SearchAfter

func (r *QueryApiKeys) SearchAfter(sortresults ...types.FieldValue) *QueryApiKeys

SearchAfter Search after definition API name: search_after

func (*QueryApiKeys) Size

func (r *QueryApiKeys) Size(size int) *QueryApiKeys

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. API name: size

func (*QueryApiKeys) Sort

func (r *QueryApiKeys) Sort(sorts ...types.SortCombinations) *QueryApiKeys

Sort Other than `id`, all public fields of an API key are eligible for sorting. In addition, sort can also be applied to the `_doc` field to sort by index order. API name: sort

func (*QueryApiKeys) WithLimitedBy

func (r *QueryApiKeys) WithLimitedBy(withlimitedby bool) *QueryApiKeys

WithLimitedBy Return the snapshot of the owner user's role descriptors associated with the API key. An API key's actual permission is the intersection of its assigned role descriptors and the owner user's role descriptors. API name: with_limited_by

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.Query `json:"query,omitempty"`
	// SearchAfter Search after definition
	SearchAfter []types.FieldValue `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 Other than `id`, all public fields of an API key are eligible for sorting.
	// In addition, sort can also be applied to the `_doc` field to sort by index
	// order.
	Sort []types.SortCombinations `json:"sort,omitempty"`
}

Request holds the request body struct for the package queryapikeys

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/security/query_api_keys/QueryApiKeysRequest.ts#L25-L74

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

func (r *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// ApiKeys A list of API key information.
	ApiKeys []types.ApiKey `json:"api_keys"`
	// Count The number of API keys returned in the response.
	Count int `json:"count"`
	// Total The total number of API keys found.
	Total int `json:"total"`
}

Response holds the response body struct for the package queryapikeys

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/security/query_api_keys/QueryApiKeysResponse.ts#L23-L38

func NewResponse

func NewResponse() *Response

NewResponse returns a Response