upgradejobsnapshot

Documentation

Overview

Upgrades a given job snapshot to the current major version.

Index

• Variables
• type NewUpgradeJobSnapshot
  • func NewUpgradeJobSnapshotFunc(tp elastictransport.Interface) NewUpgradeJobSnapshot
• type Response
  • func NewResponse() *Response
• type UpgradeJobSnapshot
  • func New(tp elastictransport.Interface) *UpgradeJobSnapshot
  • func (r UpgradeJobSnapshot) Do(providedCtx context.Context) (*Response, error)
  • func (r *UpgradeJobSnapshot) Header(key, value string) *UpgradeJobSnapshot
  • func (r *UpgradeJobSnapshot) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r UpgradeJobSnapshot) IsSuccess(providedCtx context.Context) (bool, error)
  • func (r UpgradeJobSnapshot) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *UpgradeJobSnapshot) Timeout(duration string) *UpgradeJobSnapshot
  • func (r *UpgradeJobSnapshot) WaitForCompletion(waitforcompletion bool) *UpgradeJobSnapshot

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 NewUpgradeJobSnapshot

type NewUpgradeJobSnapshot func(jobid, snapshotid string) *UpgradeJobSnapshot

NewUpgradeJobSnapshot type alias for index.

func NewUpgradeJobSnapshotFunc

func NewUpgradeJobSnapshotFunc(tp elastictransport.Interface) NewUpgradeJobSnapshot

NewUpgradeJobSnapshotFunc returns a new instance of UpgradeJobSnapshot 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 When true, this means the task is complete. When false, it is still running.
	Completed bool `json:"completed"`
	// Node The ID of the node that the upgrade task was started on if it is still
	// running. In serverless this will be the "serverless".
	Node string `json:"node"`
}

Response holds the response body struct for the package upgradejobsnapshot

https://github.com/elastic/elasticsearch-specification/blob/b2c13a00c152a97cb41193deda8ed9b37fd06796/specification/ml/upgrade_job_snapshot/MlUpgradeJobSnapshotResponse.ts#L22-L31

func NewResponse

func NewResponse() *Response

NewResponse returns a Response

type UpgradeJobSnapshot

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

func New

func New(tp elastictransport.Interface) *UpgradeJobSnapshot

Upgrades a given job snapshot to the current major version.

https://www.elastic.co/guide/en/elasticsearch/reference/current/ml-upgrade-job-model-snapshot.html

func (UpgradeJobSnapshot) Do

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

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

func (*UpgradeJobSnapshot) Header

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

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

func (*UpgradeJobSnapshot) HttpRequest

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

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

func (UpgradeJobSnapshot) IsSuccess

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

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

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

func (*UpgradeJobSnapshot) Timeout

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

Timeout Controls the time to wait for the request to complete. API name: timeout

func (*UpgradeJobSnapshot) WaitForCompletion

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

WaitForCompletion When true, the API won’t respond until the upgrade is complete. Otherwise, it responds as soon as the upgrade task is assigned to a node. API name: wait_for_completion