disableuserprofile

package
v8.4.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Aug 24, 2022 License: Apache-2.0 Imports: 11 Imported by: 4

Documentation

Overview

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

Index

Constants

This section is empty.

Variables

View Source
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.

Functions

This section is empty.

Types

type DisableUserProfile

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

func (DisableUserProfile) Do

Do runs the http.Request through the provided transport.

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(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 (*DisableUserProfile) Refresh

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

func (*DisableUserProfile) Uid

Uid Unique identifier for the user profile. API Name: uid

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.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL