resettransform

Documentation

Overview

Resets an existing transform.

Index

• Variables
• type NewResetTransform
  • func NewResetTransformFunc(tp elastictransport.Interface) NewResetTransform
• type ResetTransform
  • func New(tp elastictransport.Interface) *ResetTransform
  • func (r ResetTransform) Do(ctx context.Context) (*Response, error)
  • func (r *ResetTransform) Force(b bool) *ResetTransform
  • func (r *ResetTransform) Header(key, value string) *ResetTransform
  • func (r *ResetTransform) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r ResetTransform) IsSuccess(ctx context.Context) (bool, error)
  • func (r ResetTransform) Perform(ctx context.Context) (*http.Response, error)
  • func (r *ResetTransform) TransformId(v string) *ResetTransform
• 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 NewResetTransform

type NewResetTransform func(transformid string) *ResetTransform

NewResetTransform type alias for index.

func NewResetTransformFunc

func NewResetTransformFunc(tp elastictransport.Interface) NewResetTransform

NewResetTransformFunc returns a new instance of ResetTransform with the provided transport. Used in the index of the library this allows to retrieve every apis in once place.

type ResetTransform

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

func New

func New(tp elastictransport.Interface) *ResetTransform

Resets an existing transform.

https://www.elastic.co/guide/en/elasticsearch/reference/current/reset-transform.html

func (ResetTransform) Do

func (r ResetTransform) Do(ctx context.Context) (*Response, error)

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

func (*ResetTransform) Force

func (r *ResetTransform) Force(b bool) *ResetTransform

Force If this value is `true`, the transform is reset regardless of its current state. If it's `false`, the transform must be stopped before it can be reset. API name: force

func (*ResetTransform) Header

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

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

func (*ResetTransform) HttpRequest

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

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

func (ResetTransform) IsSuccess

func (r ResetTransform) 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 (ResetTransform) Perform

func (r ResetTransform) Perform(ctx context.Context) (*http.Response, error)

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

func (*ResetTransform) TransformId

func (r *ResetTransform) TransformId(v string) *ResetTransform

TransformId Identifier for the transform. This identifier can contain lowercase alphanumeric characters (a-z and 0-9), hyphens, and underscores. It has a 64 character limit and must start and end with alphanumeric characters. API Name: transformid

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"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response