putlifecycle

Documentation

Overview

Creates a lifecycle policy

Index

• Variables
• type NewPutLifecycle
  • func NewPutLifecycleFunc(tp elastictransport.Interface) NewPutLifecycle
• type PutLifecycle
  • func New(tp elastictransport.Interface) *PutLifecycle
  • func (r PutLifecycle) Do(ctx context.Context) (*Response, error)
  • func (r *PutLifecycle) Header(key, value string) *PutLifecycle
  • func (r *PutLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutLifecycle) MasterTimeout(v string) *PutLifecycle
  • func (r PutLifecycle) Perform(ctx context.Context) (*http.Response, error)
  • func (r *PutLifecycle) Policy(v string) *PutLifecycle
  • func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle
  • func (r *PutLifecycle) Request(req *Request) *PutLifecycle
  • func (r *PutLifecycle) Timeout(v string) *PutLifecycle
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
• 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 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 New

func New(tp elastictransport.Interface) *PutLifecycle

Creates a lifecycle policy

https://www.elastic.co/guide/en/elasticsearch/reference/current/ilm-put-lifecycle.html

func (PutLifecycle) Do

func (r PutLifecycle) Do(ctx context.Context) (*Response, error)

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

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(v 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) Perform

func (r PutLifecycle) Perform(ctx context.Context) (*http.Response, error)

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

func (*PutLifecycle) Policy

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

Policy Identifier for the policy. API Name: policy

func (*PutLifecycle) Raw

func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle

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(v 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/1ad7fe36297b3a8e187b2259dedaf68a47bc236e/specification/ilm/put_lifecycle/PutLifecycleRequest.ts#L25-L56

func NewRequest

func NewRequest() *Request

NewRequest returns a Request

func (*Request) FromJSON

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

FromJSON allows to load an arbitrary json into the request structure

type Response

type Response struct {

	// Acknowledged For a successful response, this value is always true. On failure, an
	// exception is returned instead.
	Acknowledged bool `json:"acknowledged"`
}

func NewResponse

func NewResponse() *Response

NewResponse returns a Response