get

Documentation

Overview

Returns information about a task.

Index

• Variables
• type Get
  • func New(tp elastictransport.Interface) *Get
  • func (r Get) Do(providedCtx context.Context) (*Response, error)
  • func (r *Get) Header(key, value string) *Get
  • func (r *Get) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r Get) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r Get) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *Get) Timeout(duration string) *Get
  • func (r *Get) WaitForCompletion(waitforcompletion bool) *Get
• type NewGet
  • func NewGetFunc(tp elastictransport.Interface) NewGet
• 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 Get

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

func New

func New(tp elastictransport.Interface) *Get

Returns information about a task.

https://www.elastic.co/guide/en/elasticsearch/reference/current/tasks.html

func (Get) Do

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

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

func (*Get) Header

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

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

func (*Get) HttpRequest

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

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

func (Get) IsSuccess

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

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

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

func (*Get) Timeout

func (r *Get) Timeout(duration string) *Get

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 (*Get) WaitForCompletion

func (r *Get) WaitForCompletion(waitforcompletion bool) *Get

WaitForCompletion If `true`, the request blocks until the task has completed. API name: wait_for_completion

type NewGet

type NewGet func(taskid string) *Get

NewGet type alias for index.

func NewGetFunc

func NewGetFunc(tp elastictransport.Interface) NewGet

NewGetFunc returns a new instance of Get 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 {
	Completed bool              `json:"completed"`
	Error     *types.ErrorCause `json:"error,omitempty"`
	Response  json.RawMessage   `json:"response,omitempty"`
	Task      types.TaskInfo    `json:"task"`
}

Response holds the response body struct for the package get

https://github.com/elastic/elasticsearch-specification/blob/17ac39c7f9266bc303baa029f90194aecb1c3b7c/specification/tasks/get/GetTaskResponse.ts#L24-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response