disableuserprofile

Documentation

Overview

Disables a user profile so it's not visible in user profile searches.

Index

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

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

func New

func New(tp elastictransport.Interface) *DisableUserProfile

Disables a user profile so it's not visible in user profile searches.

https://www.elastic.co/guide/en/elasticsearch/reference/current/security-api-disable-user-profile.html

func (DisableUserProfile) Do

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

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

func (*DisableUserProfile) Header

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

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

func (*DisableUserProfile) HttpRequest

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

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

func (DisableUserProfile) IsSuccess

func (r DisableUserProfile) IsSuccess(providedCtx 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 (DisableUserProfile) Perform

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

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

func (*DisableUserProfile) Refresh

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

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

type NewDisableUserProfile

type NewDisableUserProfile func(uid string) *DisableUserProfile

NewDisableUserProfile type alias for index.

func NewDisableUserProfileFunc

func NewDisableUserProfileFunc(tp elastictransport.Interface) NewDisableUserProfile

NewDisableUserProfileFunc returns a new instance of DisableUserProfile 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 {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

Response holds the response body struct for the package disableuserprofile

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/security/disable_user_profile/Response.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response