Documentation
¶
Overview ¶
Creates a lifecycle policy
Index ¶
- Variables
- type NewPutLifecycle
- type PutLifecycle
- func (r PutLifecycle) Do(providedCtx 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(duration string) *PutLifecycle
- func (r PutLifecycle) Perform(providedCtx context.Context) (*http.Response, error)
- func (r *PutLifecycle) Raw(raw io.Reader) *PutLifecycle
- func (r *PutLifecycle) Request(req *Request) *PutLifecycle
- func (r *PutLifecycle) Timeout(duration string) *PutLifecycle
- type Request
- type Response
Constants ¶
This section is empty.
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.
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 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(providedCtx 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 ¶
HttpRequest returns the http.Request object built from the given parameters.
func (*PutLifecycle) MasterTimeout ¶
func (r *PutLifecycle) MasterTimeout(duration 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 ¶ added in v8.7.0
Perform runs the http.Request through the provided transport and returns an http.Response.
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(duration 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
Source Files