updateapikeyid

Documentation

Overview

Update the connector API key ID.

Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

Index

• Variables
• type NewUpdateApiKeyId
  • func NewUpdateApiKeyIdFunc(tp elastictransport.Interface) NewUpdateApiKeyId
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• type Response
  • func NewResponse() *Response
• type UpdateApiKeyId
  • func New(tp elastictransport.Interface) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) ApiKeyId(apikeyid string) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) ApiKeySecretId(apikeysecretid string) *UpdateApiKeyId
  • func (r UpdateApiKeyId) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpdateApiKeyId) ErrorTrace(errortrace bool) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) FilterPath(filterpaths ...string) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) Header(key, value string) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *UpdateApiKeyId) Human(human bool) *UpdateApiKeyId
  • func (r UpdateApiKeyId) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpdateApiKeyId) Pretty(pretty bool) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) Raw(raw io.Reader) *UpdateApiKeyId
  • func (r *UpdateApiKeyId) Request(req *Request) *UpdateApiKeyId

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 NewUpdateApiKeyId

type NewUpdateApiKeyId func(connectorid string) *UpdateApiKeyId

NewUpdateApiKeyId type alias for index.

func NewUpdateApiKeyIdFunc

func NewUpdateApiKeyIdFunc(tp elastictransport.Interface) NewUpdateApiKeyId

NewUpdateApiKeyIdFunc returns a new instance of UpdateApiKeyId 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 {
	ApiKeyId       *string `json:"api_key_id,omitempty"`
	ApiKeySecretId *string `json:"api_key_secret_id,omitempty"`
}

Request holds the request body struct for the package updateapikeyid

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDRequest.ts#L21-L47

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 {
	Result result.Result `json:"result"`
}

Response holds the response body struct for the package updateapikeyid

https://github.com/elastic/elasticsearch-specification/blob/4fcf747dfafc951e1dcf3077327e3dcee9107db3/specification/connector/update_api_key_id/ConnectorUpdateAPIKeyIDResponse.ts#L22-L26

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpdateApiKeyId

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

func New

func New(tp elastictransport.Interface) *UpdateApiKeyId

Update the connector API key ID.

Update the `api_key_id` and `api_key_secret_id` fields of a connector. You can specify the ID of the API key used for authorization and the ID of the connector secret where the API key is stored. The connector secret ID is required only for Elastic managed (native) connectors. Self-managed connectors (connector clients) do not use this field.

https://www.elastic.co/guide/en/elasticsearch/reference/current/update-connector-api-key-id-api.html

func (*UpdateApiKeyId) ApiKeyId

func (r *UpdateApiKeyId) ApiKeyId(apikeyid string) *UpdateApiKeyId

API name: api_key_id

func (*UpdateApiKeyId) ApiKeySecretId

func (r *UpdateApiKeyId) ApiKeySecretId(apikeysecretid string) *UpdateApiKeyId

API name: api_key_secret_id

func (UpdateApiKeyId) Do

func (r UpdateApiKeyId) Do(providedCtx context.Context) (*Response, error)

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

func (*UpdateApiKeyId) ErrorTrace

func (r *UpdateApiKeyId) ErrorTrace(errortrace bool) *UpdateApiKeyId

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*UpdateApiKeyId) FilterPath

func (r *UpdateApiKeyId) FilterPath(filterpaths ...string) *UpdateApiKeyId

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

func (*UpdateApiKeyId) Header

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

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

func (*UpdateApiKeyId) HttpRequest

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

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

func (*UpdateApiKeyId) Human

func (r *UpdateApiKeyId) Human(human bool) *UpdateApiKeyId

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (UpdateApiKeyId) Perform

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

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

func (*UpdateApiKeyId) Pretty

func (r *UpdateApiKeyId) Pretty(pretty bool) *UpdateApiKeyId

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

func (*UpdateApiKeyId) Raw

func (r *UpdateApiKeyId) Raw(raw io.Reader) *UpdateApiKeyId

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

func (*UpdateApiKeyId) Request

func (r *UpdateApiKeyId) Request(req *Request) *UpdateApiKeyId

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