Documentation ¶
Overview ¶
Deletes an existing transform.
Index ¶
- Variables
- type DeleteTransform
- func (r *DeleteTransform) DeleteDestIndex(deletedestindex bool) *DeleteTransform
- func (r DeleteTransform) Do(providedCtx context.Context) (*Response, error)
- func (r *DeleteTransform) Force(force bool) *DeleteTransform
- func (r *DeleteTransform) Header(key, value string) *DeleteTransform
- func (r *DeleteTransform) HttpRequest(ctx context.Context) (*http.Request, error)
- func (r DeleteTransform) IsSuccess(providedCtx context.Context) (bool, error)
- func (r DeleteTransform) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *DeleteTransform) Timeout(duration string) *DeleteTransform
- type NewDeleteTransform
- 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 DeleteTransform ¶
type DeleteTransform struct {
// contains filtered or unexported fields
}
func New ¶
func New(tp elastictransport.Interface) *DeleteTransform
Deletes an existing transform.
https://www.elastic.co/guide/en/elasticsearch/reference/current/delete-transform.html
func (*DeleteTransform) DeleteDestIndex ¶ added in v8.11.1
func (r *DeleteTransform) DeleteDestIndex(deletedestindex bool) *DeleteTransform
DeleteDestIndex If this value is true, the destination index is deleted together with the transform. If false, the destination index will not be deleted API name: delete_dest_index
func (DeleteTransform) Do ¶
func (r DeleteTransform) Do(providedCtx context.Context) (*Response, error)
Do runs the request through the transport, handle the response and returns a deletetransform.Response
func (*DeleteTransform) Force ¶
func (r *DeleteTransform) Force(force bool) *DeleteTransform
Force If this value is false, the transform must be stopped before it can be deleted. If true, the transform is deleted regardless of its current state. API name: force
func (*DeleteTransform) Header ¶
func (r *DeleteTransform) Header(key, value string) *DeleteTransform
Header set a key, value pair in the DeleteTransform headers map.
func (*DeleteTransform) HttpRequest ¶
HttpRequest returns the http.Request object built from the given parameters.
func (DeleteTransform) IsSuccess ¶
func (r DeleteTransform) 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 (DeleteTransform) Perform ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
func (*DeleteTransform) Timeout ¶
func (r *DeleteTransform) Timeout(duration string) *DeleteTransform
Timeout Period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. API name: timeout
type NewDeleteTransform ¶
type NewDeleteTransform func(transformid string) *DeleteTransform
NewDeleteTransform type alias for index.
func NewDeleteTransformFunc ¶
func NewDeleteTransformFunc(tp elastictransport.Interface) NewDeleteTransform
NewDeleteTransformFunc returns a new instance of DeleteTransform with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.