deleteservicetoken

Documentation

Overview

Deletes a service account token.

Index

• Variables
• type DeleteServiceToken
  • func New(tp elastictransport.Interface) *DeleteServiceToken
  • func (r DeleteServiceToken) Do(ctx context.Context) (*Response, error)
  • func (r *DeleteServiceToken) Header(key, value string) *DeleteServiceToken
  • func (r *DeleteServiceToken) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r DeleteServiceToken) IsSuccess(ctx context.Context) (bool, error)
  • func (r DeleteServiceToken) Perform(ctx context.Context) (*http.Response, error)
  • func (r *DeleteServiceToken) Refresh(refresh refresh.Refresh) *DeleteServiceToken
• type NewDeleteServiceToken
  • func NewDeleteServiceTokenFunc(tp elastictransport.Interface) NewDeleteServiceToken
• 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 DeleteServiceToken

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

func New

func New(tp elastictransport.Interface) *DeleteServiceToken

Deletes a service account token.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-delete-service-token.html

func (DeleteServiceToken) Do

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

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

func (*DeleteServiceToken) Header

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

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

func (*DeleteServiceToken) HttpRequest

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

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

func (DeleteServiceToken) IsSuccess

func (r DeleteServiceToken) 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 (DeleteServiceToken) Perform

func (r DeleteServiceToken) Perform(ctx context.Context) (*http.Response, error)

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

func (*DeleteServiceToken) Refresh

func (r *DeleteServiceToken) Refresh(refresh refresh.Refresh) *DeleteServiceToken

Refresh If `true` then refresh the affected shards to make this operation visible to search, if `wait_for` (the default) then wait for a refresh to make this operation visible to search, if `false` then do nothing with refreshes. API name: refresh

type NewDeleteServiceToken

type NewDeleteServiceToken func(namespace, service, name string) *DeleteServiceToken

NewDeleteServiceToken type alias for index.

func NewDeleteServiceTokenFunc

func NewDeleteServiceTokenFunc(tp elastictransport.Interface) NewDeleteServiceToken

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

type Response

type Response struct {
	Found bool `json:"found"`
}

Response holds the response body struct for the package deleteservicetoken

https://github.com/elastic/elasticsearch-specification/blob/5fea44e006349579bf3561a82e997002e5716117/specification/security/delete_service_token/DeleteServiceTokenResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response