Documentation ¶
Overview ¶
Removes role mappings.
Index ¶
- Variables
- type DeleteRoleMapping
- func (r DeleteRoleMapping) Do(ctx context.Context) (*Response, error)
- func (r *DeleteRoleMapping) Header(key, value string) *DeleteRoleMapping
- func (r *DeleteRoleMapping) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteRoleMapping) IsSuccess(ctx context.Context) (bool, error)
- func (r *DeleteRoleMapping) Name(v string) *DeleteRoleMapping
- func (r DeleteRoleMapping) Perform(ctx context.Context) (*http.Response, error)
- func (r *DeleteRoleMapping) Refresh(enum refresh.Refresh) *DeleteRoleMapping
- type NewDeleteRoleMapping
- 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 DeleteRoleMapping ¶
type DeleteRoleMapping struct {
// contains filtered or unexported fields
}
func (DeleteRoleMapping) Do ¶
func (r DeleteRoleMapping) Do(ctx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deleterolemapping.Response
func (*DeleteRoleMapping) Header ¶
func (r *DeleteRoleMapping) Header(key, value string) *DeleteRoleMapping
Header set a key, value pair in the DeleteRoleMapping headers map.
func (*DeleteRoleMapping) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteRoleMapping) IsSuccess ¶
func (r DeleteRoleMapping) 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 (*DeleteRoleMapping) Name ¶
func (r *DeleteRoleMapping) Name(v string) *DeleteRoleMapping
Name Role-mapping name API Name: name
func (DeleteRoleMapping) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteRoleMapping) Refresh ¶
func (r *DeleteRoleMapping) Refresh(enum refresh.Refresh) *DeleteRoleMapping
Refresh If `true` (the default) then refresh 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` then do nothing with refreshes. API name: refresh
type NewDeleteRoleMapping ¶
type NewDeleteRoleMapping func(name string) *DeleteRoleMapping
NewDeleteRoleMapping type alias for index.
func NewDeleteRoleMappingFunc ¶
func NewDeleteRoleMappingFunc(tp elastictransport.Interface) NewDeleteRoleMapping
NewDeleteRoleMappingFunc returns a new instance of DeleteRoleMapping with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.