Documentation
¶
Overview ¶
Disables a user profile so it's not visible in user profile searches.
Index ¶
- Variables
- type 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
- type Response
Constants ¶
This section is empty.
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.
Functions ¶
This section is empty.
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.
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 ¶
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 ¶ added in v8.7.0
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.
Source Files