putlifecycle

package
v8.6.0 Latest Latest
Warning

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

Go to latest
Published: Jan 11, 2023 License: Apache-2.0 Imports: 10 Imported by: 4

Documentation

Overview

Creates a lifecycle policy

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 NewPutLifecycle

type NewPutLifecycle func(policy string) *PutLifecycle

NewPutLifecycle type alias for index.

func NewPutLifecycleFunc

func NewPutLifecycleFunc(tp elastictransport.Interface) NewPutLifecycle

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

type PutLifecycle

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

func (PutLifecycle) Do

Do runs the http.Request through the provided transport.

func (*PutLifecycle) Header

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

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

func (*PutLifecycle) HttpRequest

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

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

func (*PutLifecycle) MasterTimeout

func (r *PutLifecycle) MasterTimeout(value string) *PutLifecycle

MasterTimeout Period to wait for a connection to the master node. If no response is received before the timeout expires, the request fails and returns an error. API name: master_timeout

func (*PutLifecycle) Policy

func (r *PutLifecycle) Policy(v string) *PutLifecycle

Policy Identifier for the policy. API Name: policy

func (*PutLifecycle) Raw

Raw takes a json payload as input which is then passed to the http.Request If specified Raw takes precedence on Request method.

func (*PutLifecycle) Request

func (r *PutLifecycle) Request(req *Request) *PutLifecycle

Request allows to set the request property with the appropriate payload.

func (*PutLifecycle) Timeout

func (r *PutLifecycle) Timeout(value string) *PutLifecycle

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

type Request

type Request struct {
	Policy *types.IlmPolicy `json:"policy,omitempty"`
}

Request holds the request body struct for the package putlifecycle

https://github.com/elastic/elasticsearch-specification/blob/7f49eec1f23a5ae155001c058b3196d85981d5c2/specification/ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L56

func NewRequest added in v8.5.0

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON added in v8.5.0

func (rb *Request) FromJSON(data string) (*Request, error)

FromJSON allows to load an arbitrary json into the request structure

Jump to

Keyboard shortcuts

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