startjob

Documentation

Overview

Starts an existing, stopped rollup job.

Index

• Variables
• type NewStartJob
  • func NewStartJobFunc(tp elastictransport.Interface) NewStartJob
• type Response
  • func NewResponse() *Response
• type StartJob
  • func New(tp elastictransport.Interface) *StartJob
  • func (r StartJob) Do(providedCtx context.Context) (*Response, error)
  • func (r *StartJob) Header(key, value string) *StartJob
  • func (r *StartJob) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r StartJob) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r StartJob) Perform(providedCtx context.Context) (*http.Response, error)

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 NewStartJob

type NewStartJob func(id string) *StartJob

NewStartJob type alias for index.

func NewStartJobFunc

func NewStartJobFunc(tp elastictransport.Interface) NewStartJob

NewStartJobFunc returns a new instance of StartJob 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 {
	Started bool `json:"started"`
}

Response holds the response body struct for the package startjob

https://github.com/elastic/elasticsearch-specification/blob/5fb8f1ce9c4605abcaa44aa0f17dbfc60497a757/specification/rollup/start_job/StartRollupJobResponse.ts#L20-L22

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type StartJob

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

func New

func New(tp elastictransport.Interface) *StartJob

Starts an existing, stopped rollup job.

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

func (StartJob) Do

func (r StartJob) Do(providedCtx context.Context) (*Response, error)

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

func (*StartJob) Header

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

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

func (*StartJob) HttpRequest

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

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

func (StartJob) IsSuccess

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

func (r StartJob) Perform(providedCtx context.Context) (*http.Response, error)

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