starttransform

Documentation

Overview

Starts one or more transforms.

Index

• Variables
• type NewStartTransform
  • func NewStartTransformFunc(tp elastictransport.Interface) NewStartTransform
• type Response
  • func NewResponse() *Response
• type StartTransform
  • func New(tp elastictransport.Interface) *StartTransform
  • func (r StartTransform) Do(ctx context.Context) (*Response, error)
  • func (r *StartTransform) Header(key, value string) *StartTransform
  • func (r *StartTransform) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StartTransform) IsSuccess(ctx context.Context) (bool, error)
  • func (r StartTransform) Perform(ctx context.Context) (*http.Response, error)
  • func (r *StartTransform) Timeout(v string) *StartTransform
  • func (r *StartTransform) TransformId(v string) *StartTransform

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 NewStartTransform

type NewStartTransform func(transformid string) *StartTransform

NewStartTransform type alias for index.

func NewStartTransformFunc

func NewStartTransformFunc(tp elastictransport.Interface) NewStartTransform

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

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

type StartTransform

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

func New

func New(tp elastictransport.Interface) *StartTransform

Starts one or more transforms.

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

func (StartTransform) Do

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

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

func (*StartTransform) Header

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

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

func (*StartTransform) HttpRequest

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

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

func (StartTransform) IsSuccess

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

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

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

func (*StartTransform) Timeout

func (r *StartTransform) Timeout(v string) *StartTransform

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

func (*StartTransform) TransformId

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

TransformId Identifier for the transform. API Name: transformid