get

package
v8.11.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 27, 2023 License: Apache-2.0 Imports: 13 Imported by: 4

Documentation

Overview

Returns information about a task.

Index

Constants

This section is empty.

Variables

View Source
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 Get

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

func (Get) Do

func (r Get) Do(ctx 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(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 (Get) Perform added in v8.7.0

func (r Get) Perform(ctx 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 added in v8.7.0

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/5fea44e006349579bf3561a82e997002e5716117/specification/tasks/get/GetTaskResponse.ts#L24-L31

func NewResponse added in v8.7.0

func NewResponse() *Response

NewResponse returns a Response

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL