putlifecycle

Documentation

Overview

Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored.

Index

• Variables
• type NewPutLifecycle
  • func NewPutLifecycleFunc(tp elastictransport.Interface) NewPutLifecycle
• type PutLifecycle
  • func New(tp elastictransport.Interface) *PutLifecycle
  • func (r *PutLifecycle) Config(config *types.Configuration) *PutLifecycle
  • func (r PutLifecycle) Do(providedCtx context.Context) (*Response, error)
  • func (r *PutLifecycle) ErrorTrace(errortrace bool) *PutLifecycle
  • func (r *PutLifecycle) FilterPath(filterpaths ...string) *PutLifecycle
  • func (r *PutLifecycle) Header(key, value string) *PutLifecycle
  • func (r *PutLifecycle) HttpRequest(ctx context.Context) (*http.Request, error)
  • func (r *PutLifecycle) Human(human bool) *PutLifecycle
  • func (r *PutLifecycle) MasterTimeout(duration string) *PutLifecycle
  • func (r *PutLifecycle) Name(name string) *PutLifecycle
  • func (r PutLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
  • func (r *PutLifecycle) Pretty(pretty bool) *PutLifecycle
  • func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle
  • func (r *PutLifecycle) Repository(repository string) *PutLifecycle
  • func (r *PutLifecycle) Request(req *Request) *PutLifecycle
  • func (r *PutLifecycle) Retention(retention *types.Retention) *PutLifecycle
  • func (r *PutLifecycle) Schedule(cronexpression string) *PutLifecycle
  • func (r *PutLifecycle) Timeout(duration string) *PutLifecycle
• type Request
  • func NewRequest() *Request
  • func (r *Request) FromJSON(data string) (*Request, error)
  • func (s *Request) UnmarshalJSON(data []byte) 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(policyid 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

Create or update a policy. Create or update a snapshot lifecycle policy. If the policy already exists, this request increments the policy version. Only the latest version of a policy is stored.

https://www.elastic.co/guide/en/elasticsearch/reference/current/slm-api-put-policy.html

func (*PutLifecycle) Config

func (r *PutLifecycle) Config(config *types.Configuration) *PutLifecycle

Config Configuration for each snapshot created by the policy. API name: config

func (PutLifecycle) Do

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

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

func (*PutLifecycle) ErrorTrace

func (r *PutLifecycle) ErrorTrace(errortrace bool) *PutLifecycle

ErrorTrace When set to `true` Elasticsearch will include the full stack trace of errors when they occur. API name: error_trace

func (*PutLifecycle) FilterPath

func (r *PutLifecycle) FilterPath(filterpaths ...string) *PutLifecycle

FilterPath Comma-separated list of filters in dot notation which reduce the response returned by Elasticsearch. API name: filter_path

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) Human

func (r *PutLifecycle) Human(human bool) *PutLifecycle

Human When set to `true` will return statistics in a format suitable for humans. For example `"exists_time": "1h"` for humans and `"eixsts_time_in_millis": 3600000` for computers. When disabled the human readable values will be omitted. This makes sense for responses being consumed only by machines. API name: human

func (*PutLifecycle) MasterTimeout

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

MasterTimeout The 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. To indicate that the request should never timeout, set it to `-1`. API name: master_timeout

func (*PutLifecycle) Name

func (r *PutLifecycle) Name(name string) *PutLifecycle

Name Name automatically assigned to each snapshot created by the policy. Date math is supported. To prevent conflicting snapshot names, a UUID is automatically appended to each snapshot name. API name: name

func (PutLifecycle) Perform

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

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

func (*PutLifecycle) Pretty

func (r *PutLifecycle) Pretty(pretty bool) *PutLifecycle

Pretty If set to `true` the returned JSON will be "pretty-formatted". Only use this option for debugging only. API name: pretty

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) Repository

func (r *PutLifecycle) Repository(repository string) *PutLifecycle

Repository Repository used to store snapshots created by this policy. This repository must exist prior to the policy’s creation. You can create a repository using the snapshot repository API. API name: repository

func (*PutLifecycle) Request

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

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

func (*PutLifecycle) Retention

func (r *PutLifecycle) Retention(retention *types.Retention) *PutLifecycle

Retention Retention rules used to retain and delete snapshots created by the policy. API name: retention

func (*PutLifecycle) Schedule

func (r *PutLifecycle) Schedule(cronexpression string) *PutLifecycle

Schedule Periodic or absolute schedule at which the policy creates snapshots. SLM applies schedule changes immediately. API name: schedule

func (*PutLifecycle) Timeout

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

Timeout The period to wait for a response. If no response is received before the timeout expires, the request fails and returns an error. To indicate that the request should never timeout, set it to `-1`. API name: timeout

type Request

type Request struct {

	// Config Configuration for each snapshot created by the policy.
	Config *types.Configuration `json:"config,omitempty"`
	// Name Name automatically assigned to each snapshot created by the policy. Date math
	// is supported. To prevent conflicting snapshot names, a UUID is automatically
	// appended to each snapshot name.
	Name *string `json:"name,omitempty"`
	// Repository Repository used to store snapshots created by this policy. This repository
	// must exist prior to the policy’s creation. You can create a repository using
	// the snapshot repository API.
	Repository *string `json:"repository,omitempty"`
	// Retention Retention rules used to retain and delete snapshots created by the policy.
	Retention *types.Retention `json:"retention,omitempty"`
	// Schedule Periodic or absolute schedule at which the policy creates snapshots. SLM
	// applies schedule changes immediately.
	Schedule *string `json:"schedule,omitempty"`
}

Request holds the request body struct for the package putlifecycle

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/slm/put_lifecycle/PutSnapshotLifecycleRequest.ts#L26-L89

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

func (*Request) UnmarshalJSON

func (s *Request) UnmarshalJSON(data []byte) error

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"`
}

Response holds the response body struct for the package putlifecycle

https://github.com/elastic/elasticsearch-specification/blob/470b4b9aaaa25cae633ec690e54b725c6fc939c7/specification/slm/put_lifecycle/PutSnapshotLifecycleResponse.ts#L22-L24

func NewResponse

func NewResponse() *Response

NewResponse returns a Response